mirror of
https://github.com/element-hq/synapse.git
synced 2024-11-27 12:08:32 +03:00
331 lines
12 KiB
Python
331 lines
12 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
#
|
|
# 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.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
from typing import Any, Mapping, Optional
|
|
from unittest.mock import Mock
|
|
|
|
from immutabledict import immutabledict
|
|
|
|
from synapse.config import ConfigError
|
|
from synapse.config.workers import WorkerConfig
|
|
|
|
from tests.unittest import TestCase
|
|
|
|
_EMPTY_IMMUTABLEDICT: Mapping[str, Any] = immutabledict()
|
|
|
|
|
|
class WorkerDutyConfigTestCase(TestCase):
|
|
def _make_worker_config(
|
|
self,
|
|
worker_app: str,
|
|
worker_name: Optional[str],
|
|
extras: Mapping[str, Any] = _EMPTY_IMMUTABLEDICT,
|
|
) -> WorkerConfig:
|
|
root_config = Mock()
|
|
root_config.worker_app = worker_app
|
|
root_config.worker_name = worker_name
|
|
worker_config = WorkerConfig(root_config)
|
|
worker_config_dict = {
|
|
"worker_name": worker_name,
|
|
"worker_app": worker_app,
|
|
**extras,
|
|
}
|
|
worker_config.read_config(worker_config_dict)
|
|
return worker_config
|
|
|
|
def test_old_configs_master(self) -> None:
|
|
"""
|
|
Tests old (legacy) config options. This is for the master's config.
|
|
"""
|
|
main_process_config = self._make_worker_config(
|
|
worker_app="synapse.app.homeserver", worker_name=None
|
|
)
|
|
|
|
self.assertTrue(
|
|
main_process_config._should_this_worker_perform_duty(
|
|
{},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
self.assertTrue(
|
|
main_process_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": True,
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
self.assertFalse(
|
|
main_process_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": False,
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
def test_old_configs_appservice_worker(self) -> None:
|
|
"""
|
|
Tests old (legacy) config options. This is for the worker's config.
|
|
"""
|
|
appservice_worker_config = self._make_worker_config(
|
|
worker_app="synapse.app.appservice",
|
|
worker_name="worker1",
|
|
extras={
|
|
# Set notify_appservices to false for the initialiser's config,
|
|
# so that it doesn't raise an exception here.
|
|
# (This is not read by `_should_this_worker_perform_duty`.)
|
|
"notify_appservices": False,
|
|
"instance_map": {"main": {"host": "127.0.0.1", "port": 0}},
|
|
},
|
|
)
|
|
|
|
with self.assertRaises(ConfigError):
|
|
# This raises because you need to set notify_appservices: False
|
|
# before using the synapse.app.appservice worker type
|
|
self.assertFalse(
|
|
appservice_worker_config._should_this_worker_perform_duty(
|
|
{},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
with self.assertRaises(ConfigError):
|
|
# This also raises because you need to set notify_appservices: False
|
|
# before using the synapse.app.appservice worker type
|
|
appservice_worker_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": True,
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
|
|
self.assertTrue(
|
|
appservice_worker_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": False,
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
def test_transitional_configs_master(self) -> None:
|
|
"""
|
|
Tests transitional (legacy + new) config options. This is for the master's config.
|
|
"""
|
|
|
|
main_process_config = self._make_worker_config(
|
|
worker_app="synapse.app.homeserver",
|
|
worker_name=None,
|
|
extras={"instance_map": {"main": {"host": "127.0.0.1", "port": 0}}},
|
|
)
|
|
|
|
self.assertTrue(
|
|
main_process_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": True,
|
|
"notify_appservices_from_worker": "master",
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
self.assertFalse(
|
|
main_process_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": False,
|
|
"notify_appservices_from_worker": "worker1",
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
with self.assertRaises(ConfigError):
|
|
# Contradictory because we say the master should notify appservices,
|
|
# then we say worker1 is the designated worker to do that!
|
|
main_process_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": True,
|
|
"notify_appservices_from_worker": "worker1",
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
|
|
with self.assertRaises(ConfigError):
|
|
# Contradictory because we say the master shouldn't notify appservices,
|
|
# then we say master is the designated worker to do that!
|
|
main_process_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": False,
|
|
"notify_appservices_from_worker": "master",
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
|
|
def test_transitional_configs_appservice_worker(self) -> None:
|
|
"""
|
|
Tests transitional (legacy + new) config options. This is for the worker's config.
|
|
"""
|
|
appservice_worker_config = self._make_worker_config(
|
|
worker_app="synapse.app.appservice",
|
|
worker_name="worker1",
|
|
extras={
|
|
# Set notify_appservices to false for the initialiser's config,
|
|
# so that it doesn't raise an exception here.
|
|
# (This is not read by `_should_this_worker_perform_duty`.)
|
|
"notify_appservices": False,
|
|
"instance_map": {"main": {"host": "127.0.0.1", "port": 0}},
|
|
},
|
|
)
|
|
|
|
self.assertTrue(
|
|
appservice_worker_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": False,
|
|
"notify_appservices_from_worker": "worker1",
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
with self.assertRaises(ConfigError):
|
|
# This raises because this worker is the appservice app type, yet
|
|
# another worker is the designated worker!
|
|
appservice_worker_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices": False,
|
|
"notify_appservices_from_worker": "worker2",
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
|
|
def test_new_configs_master(self) -> None:
|
|
"""
|
|
Tests new config options. This is for the master's config.
|
|
"""
|
|
main_process_config = self._make_worker_config(
|
|
worker_app="synapse.app.homeserver",
|
|
worker_name=None,
|
|
extras={"instance_map": {"main": {"host": "127.0.0.1", "port": 0}}},
|
|
)
|
|
|
|
self.assertTrue(
|
|
main_process_config._should_this_worker_perform_duty(
|
|
{"notify_appservices_from_worker": None},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
self.assertFalse(
|
|
main_process_config._should_this_worker_perform_duty(
|
|
{"notify_appservices_from_worker": "worker1"},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
def test_new_configs_appservice_worker(self) -> None:
|
|
"""
|
|
Tests new config options. This is for the worker's config.
|
|
"""
|
|
appservice_worker_config = self._make_worker_config(
|
|
worker_app="synapse.app.generic_worker",
|
|
worker_name="worker1",
|
|
extras={"instance_map": {"main": {"host": "127.0.0.1", "port": 0}}},
|
|
)
|
|
|
|
self.assertTrue(
|
|
appservice_worker_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices_from_worker": "worker1",
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
self.assertFalse(
|
|
appservice_worker_config._should_this_worker_perform_duty(
|
|
{
|
|
"notify_appservices_from_worker": "worker2",
|
|
},
|
|
"notify_appservices",
|
|
"synapse.app.appservice",
|
|
"notify_appservices_from_worker",
|
|
)
|
|
)
|
|
|
|
def test_worker_duty_configs(self) -> None:
|
|
"""
|
|
Additional tests for the worker duties
|
|
"""
|
|
|
|
worker1_config = self._make_worker_config(
|
|
worker_app="synapse.app.generic_worker",
|
|
worker_name="worker1",
|
|
extras={
|
|
"notify_appservices_from_worker": "worker2",
|
|
"update_user_directory_from_worker": "worker1",
|
|
"instance_map": {"main": {"host": "127.0.0.1", "port": 0}},
|
|
},
|
|
)
|
|
self.assertFalse(worker1_config.should_notify_appservices)
|
|
self.assertTrue(worker1_config.should_update_user_directory)
|
|
|
|
worker2_config = self._make_worker_config(
|
|
worker_app="synapse.app.generic_worker",
|
|
worker_name="worker2",
|
|
extras={
|
|
"notify_appservices_from_worker": "worker2",
|
|
"update_user_directory_from_worker": "worker1",
|
|
"instance_map": {"main": {"host": "127.0.0.1", "port": 0}},
|
|
},
|
|
)
|
|
self.assertTrue(worker2_config.should_notify_appservices)
|
|
self.assertFalse(worker2_config.should_update_user_directory)
|