mirror of
https://github.com/element-hq/synapse.git
synced 2025-12-16 00:00:58 -05:00
6e910e2b2c
Fix a couple type annotations in the `RootConfig`/`Config`. Discovered while cribbing this code for another project. It's really sucks that `mypy` type checking doesn't catch this. I assume this is because we also have a `synapse/config/_base.pyi` that overrides all of this. Still unclear to me why the `Iterable[str]` vs `StrSequence` issue wasn't caught as that's what `ConfigError` expects.
147 lines
4.0 KiB
Python
147 lines
4.0 KiB
Python
from unittest import TestCase as StdlibTestCase
|
|
|
|
import yaml
|
|
|
|
from synapse.config import ConfigError
|
|
from synapse.config._base import RootConfig
|
|
from synapse.config.api import ApiConfig
|
|
from synapse.types.state import StateFilter
|
|
|
|
DEFAULT_PREJOIN_STATE_PAIRS = {
|
|
("m.room.join_rules", ""),
|
|
("m.room.canonical_alias", ""),
|
|
("m.room.avatar", ""),
|
|
("m.room.encryption", ""),
|
|
("m.room.name", ""),
|
|
("m.room.create", ""),
|
|
("m.room.topic", ""),
|
|
}
|
|
|
|
|
|
class TestRoomPrejoinState(StdlibTestCase):
|
|
def read_config(self, source: str) -> ApiConfig:
|
|
config = ApiConfig(RootConfig())
|
|
config.read_config(yaml.safe_load(source))
|
|
return config
|
|
|
|
def test_no_prejoin_state(self) -> None:
|
|
config = self.read_config("foo: bar")
|
|
self.assertFalse(config.room_prejoin_state.has_wildcards())
|
|
self.assertEqual(
|
|
set(config.room_prejoin_state.concrete_types()), DEFAULT_PREJOIN_STATE_PAIRS
|
|
)
|
|
|
|
def test_disable_default_event_types(self) -> None:
|
|
config = self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
disable_default_event_types: true
|
|
"""
|
|
)
|
|
self.assertEqual(config.room_prejoin_state, StateFilter.none())
|
|
|
|
def test_event_without_state_key(self) -> None:
|
|
config = self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
disable_default_event_types: true
|
|
additional_event_types:
|
|
- foo
|
|
"""
|
|
)
|
|
self.assertEqual(config.room_prejoin_state.wildcard_types(), ["foo"])
|
|
self.assertEqual(config.room_prejoin_state.concrete_types(), [])
|
|
|
|
def test_event_with_specific_state_key(self) -> None:
|
|
config = self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
disable_default_event_types: true
|
|
additional_event_types:
|
|
- [foo, bar]
|
|
"""
|
|
)
|
|
self.assertFalse(config.room_prejoin_state.has_wildcards())
|
|
self.assertEqual(
|
|
set(config.room_prejoin_state.concrete_types()),
|
|
{("foo", "bar")},
|
|
)
|
|
|
|
def test_repeated_event_with_specific_state_key(self) -> None:
|
|
config = self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
disable_default_event_types: true
|
|
additional_event_types:
|
|
- [foo, bar]
|
|
- [foo, baz]
|
|
"""
|
|
)
|
|
self.assertFalse(config.room_prejoin_state.has_wildcards())
|
|
self.assertEqual(
|
|
set(config.room_prejoin_state.concrete_types()),
|
|
{("foo", "bar"), ("foo", "baz")},
|
|
)
|
|
|
|
def test_no_specific_state_key_overrides_specific_state_key(self) -> None:
|
|
config = self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
disable_default_event_types: true
|
|
additional_event_types:
|
|
- [foo, bar]
|
|
- foo
|
|
"""
|
|
)
|
|
self.assertEqual(config.room_prejoin_state.wildcard_types(), ["foo"])
|
|
self.assertEqual(config.room_prejoin_state.concrete_types(), [])
|
|
|
|
config = self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
disable_default_event_types: true
|
|
additional_event_types:
|
|
- foo
|
|
- [foo, bar]
|
|
"""
|
|
)
|
|
self.assertEqual(config.room_prejoin_state.wildcard_types(), ["foo"])
|
|
self.assertEqual(config.room_prejoin_state.concrete_types(), [])
|
|
|
|
def test_bad_event_type_entry_raises(self) -> None:
|
|
with self.assertRaises(ConfigError):
|
|
self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
additional_event_types:
|
|
- []
|
|
"""
|
|
)
|
|
|
|
with self.assertRaises(ConfigError):
|
|
self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
additional_event_types:
|
|
- [a]
|
|
"""
|
|
)
|
|
|
|
with self.assertRaises(ConfigError):
|
|
self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
additional_event_types:
|
|
- [a, b, c]
|
|
"""
|
|
)
|
|
|
|
with self.assertRaises(ConfigError):
|
|
self.read_config(
|
|
"""
|
|
room_prejoin_state:
|
|
additional_event_types:
|
|
- [true, 1.23]
|
|
"""
|
|
)
|