mirror of
https://github.com/element-hq/synapse.git
synced 2026-03-31 06:15:44 +00:00
353 lines
12 KiB
Python
353 lines
12 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
|
# 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]
|
|
#
|
|
#
|
|
import copy
|
|
from unittest import skipUnless
|
|
|
|
from immutabledict import immutabledict
|
|
from parameterized import parameterized_class
|
|
from pydantic import BaseModel, PydanticInvalidForJsonSchema, ValidationError
|
|
|
|
from synapse.api.errors import SynapseError
|
|
from synapse.types import (
|
|
Absent,
|
|
AbsentType,
|
|
AbstractMultiWriterStreamToken,
|
|
MultiWriterStreamToken,
|
|
NonNegativeStrictInt,
|
|
RoomAlias,
|
|
RoomStreamToken,
|
|
UserID,
|
|
get_domain_from_id,
|
|
get_localpart_from_id,
|
|
map_username_to_mxid_localpart,
|
|
)
|
|
|
|
from tests import unittest
|
|
from tests.utils import USE_POSTGRES_FOR_TESTS
|
|
|
|
|
|
class IsMineIDTests(unittest.HomeserverTestCase):
|
|
def test_is_mine_id(self) -> None:
|
|
self.assertTrue(self.hs.is_mine_id("@user:test"))
|
|
self.assertTrue(self.hs.is_mine_id("#room:test"))
|
|
self.assertTrue(self.hs.is_mine_id("invalid:test"))
|
|
|
|
self.assertFalse(self.hs.is_mine_id("@user:test\0"))
|
|
self.assertFalse(self.hs.is_mine_id("@user"))
|
|
|
|
def test_two_colons(self) -> None:
|
|
"""Test handling of IDs containing more than one colon."""
|
|
# The domain starts after the first colon.
|
|
# These functions must interpret things consistently.
|
|
self.assertFalse(self.hs.is_mine_id("@user:test:test"))
|
|
self.assertEqual("user", get_localpart_from_id("@user:test:test"))
|
|
self.assertEqual("test:test", get_domain_from_id("@user:test:test"))
|
|
|
|
|
|
class UserIDTestCase(unittest.HomeserverTestCase):
|
|
def test_parse(self) -> None:
|
|
user = UserID.from_string("@1234abcd:test")
|
|
|
|
self.assertEqual("1234abcd", user.localpart)
|
|
self.assertEqual("test", user.domain)
|
|
self.assertEqual(True, self.hs.is_mine(user))
|
|
|
|
def test_parse_rejects_empty_id(self) -> None:
|
|
with self.assertRaises(SynapseError):
|
|
UserID.from_string("")
|
|
|
|
def test_parse_rejects_missing_sigil(self) -> None:
|
|
with self.assertRaises(SynapseError):
|
|
UserID.from_string("alice:example.com")
|
|
|
|
def test_parse_rejects_missing_separator(self) -> None:
|
|
with self.assertRaises(SynapseError):
|
|
UserID.from_string("@alice.example.com")
|
|
|
|
def test_validation_rejects_missing_domain(self) -> None:
|
|
self.assertFalse(UserID.is_valid("@alice:"))
|
|
|
|
def test_build(self) -> None:
|
|
user = UserID("5678efgh", "my.domain")
|
|
|
|
self.assertEqual(user.to_string(), "@5678efgh:my.domain")
|
|
|
|
def test_compare(self) -> None:
|
|
userA = UserID.from_string("@userA:my.domain")
|
|
userAagain = UserID.from_string("@userA:my.domain")
|
|
userB = UserID.from_string("@userB:my.domain")
|
|
|
|
self.assertTrue(userA == userAagain)
|
|
self.assertTrue(userA != userB)
|
|
|
|
|
|
class RoomAliasTestCase(unittest.HomeserverTestCase):
|
|
def test_parse(self) -> None:
|
|
room = RoomAlias.from_string("#channel:test")
|
|
|
|
self.assertEqual("channel", room.localpart)
|
|
self.assertEqual("test", room.domain)
|
|
self.assertEqual(True, self.hs.is_mine(room))
|
|
|
|
def test_build(self) -> None:
|
|
room = RoomAlias("channel", "my.domain")
|
|
|
|
self.assertEqual(room.to_string(), "#channel:my.domain")
|
|
|
|
def test_validate(self) -> None:
|
|
id_string = "#test:domain,test"
|
|
self.assertFalse(RoomAlias.is_valid(id_string))
|
|
|
|
|
|
class MapUsernameTestCase(unittest.TestCase):
|
|
def test_pass_througuh(self) -> None:
|
|
self.assertEqual(map_username_to_mxid_localpart("test1234"), "test1234")
|
|
|
|
def test_upper_case(self) -> None:
|
|
self.assertEqual(map_username_to_mxid_localpart("tEST_1234"), "test_1234")
|
|
self.assertEqual(
|
|
map_username_to_mxid_localpart("tEST_1234", case_sensitive=True),
|
|
"t_e_s_t__1234",
|
|
)
|
|
|
|
def test_symbols(self) -> None:
|
|
self.assertEqual(
|
|
map_username_to_mxid_localpart("test=$?_1234"), "test=3d=24=3f_1234"
|
|
)
|
|
|
|
def test_leading_underscore(self) -> None:
|
|
self.assertEqual(map_username_to_mxid_localpart("_test_1234"), "=5ftest_1234")
|
|
|
|
def test_non_ascii(self) -> None:
|
|
# this should work with either a unicode or a bytes
|
|
self.assertEqual(map_username_to_mxid_localpart("têst"), "t=c3=aast")
|
|
self.assertEqual(map_username_to_mxid_localpart("têst".encode()), "t=c3=aast")
|
|
|
|
|
|
@parameterized_class(
|
|
("token_type",),
|
|
[
|
|
(MultiWriterStreamToken,),
|
|
(RoomStreamToken,),
|
|
],
|
|
class_name_func=lambda cls,
|
|
num,
|
|
params_dict: f"{cls.__name__}_{params_dict['token_type'].__name__}",
|
|
)
|
|
class MultiWriterTokenTestCase(unittest.HomeserverTestCase):
|
|
"""Tests for the different types of multi writer tokens."""
|
|
|
|
token_type: type[AbstractMultiWriterStreamToken]
|
|
|
|
def test_basic_token(self) -> None:
|
|
"""Test that a simple stream token can be serialized and unserialized"""
|
|
store = self.hs.get_datastores().main
|
|
|
|
token = self.token_type(stream=5)
|
|
|
|
string_token = self.get_success(token.to_string(store))
|
|
|
|
if isinstance(token, RoomStreamToken):
|
|
self.assertEqual(string_token, "s5")
|
|
else:
|
|
self.assertEqual(string_token, "5")
|
|
|
|
parsed_token = self.get_success(self.token_type.parse(store, string_token))
|
|
self.assertEqual(parsed_token, token)
|
|
|
|
@skipUnless(USE_POSTGRES_FOR_TESTS, "Requires Postgres")
|
|
def test_instance_map(self) -> None:
|
|
"""Test for stream token with instance map"""
|
|
store = self.hs.get_datastores().main
|
|
|
|
token = self.token_type(stream=5, instance_map=immutabledict({"foo": 6}))
|
|
|
|
string_token = self.get_success(token.to_string(store))
|
|
self.assertEqual(string_token, "m5~1.6")
|
|
|
|
parsed_token = self.get_success(self.token_type.parse(store, string_token))
|
|
self.assertEqual(parsed_token, token)
|
|
|
|
def test_instance_map_assertion(self) -> None:
|
|
"""Test that we assert values in the instance map are greater than the
|
|
min stream position"""
|
|
|
|
with self.assertRaises(ValueError):
|
|
self.token_type(stream=5, instance_map=immutabledict({"foo": 4}))
|
|
|
|
with self.assertRaises(ValueError):
|
|
self.token_type(stream=5, instance_map=immutabledict({"foo": 5}))
|
|
|
|
def test_parse_bad_token(self) -> None:
|
|
"""Test that we can parse tokens produced by a bug in Synapse of the
|
|
form `m5~`"""
|
|
store = self.hs.get_datastores().main
|
|
|
|
parsed_token = self.get_success(self.token_type.parse(store, "m5~"))
|
|
self.assertEqual(parsed_token, self.token_type(stream=5))
|
|
|
|
|
|
class AbsentTestCase(unittest.TestCase):
|
|
"""
|
|
Tests for the `Absent` utility, which is meant to be like `None` except
|
|
explicitly signalling absence rather than JSON null.
|
|
"""
|
|
|
|
def test_cant_create_second_absent(self) -> None:
|
|
"""
|
|
Tests that we aren't allowed to instantiate a second `Absent`.
|
|
"""
|
|
with self.assertRaises(TypeError):
|
|
AbsentType() # type: ignore[call-arg]
|
|
|
|
def test_is_falsy(self) -> None:
|
|
"""
|
|
Tests `Absent` is falsy and can therefore be used a bit like `None`.
|
|
"""
|
|
if Absent:
|
|
self.fail("Absent is truthy!")
|
|
|
|
self.assertEqual(Absent or "something", "something")
|
|
|
|
def test_pydantic_jsonschema(self) -> None:
|
|
"""
|
|
Tests that `Absent` can't be used to produce JSONSchema in Pydantic models.
|
|
|
|
In the future, it may be useful to produce correct JSONSchema, but for now
|
|
I was mostly interested in making sure we don't produce weird/invalid JSONSchema.
|
|
"""
|
|
|
|
class MyModel(BaseModel):
|
|
absent: AbsentType = Absent
|
|
|
|
with self.assertRaises(PydanticInvalidForJsonSchema):
|
|
MyModel.model_json_schema()
|
|
|
|
def test_pydantic_reject_null(self) -> None:
|
|
"""
|
|
Tests that `Absent` rejects `None` (JSON null) when used in Pydantic models.
|
|
"""
|
|
|
|
class MyModel(BaseModel):
|
|
absent: AbsentType = Absent
|
|
|
|
with self.assertRaises(ValidationError):
|
|
MyModel.model_validate({"absent": None})
|
|
|
|
with self.assertRaises(ValidationError):
|
|
MyModel.model_validate_json('{"absent": null}')
|
|
|
|
def test_pydantic_accept_absence(self) -> None:
|
|
"""
|
|
Tests that `Absent` accepts the absence of a value when used in Pydantic models.
|
|
"""
|
|
|
|
class MyModel(BaseModel):
|
|
absent: AbsentType = Absent
|
|
|
|
self.assertEqual(MyModel.model_validate({}), MyModel(absent=Absent))
|
|
self.assertEqual(MyModel.model_validate_json("{}"), MyModel(absent=Absent))
|
|
|
|
def test_copy(self) -> None:
|
|
"""
|
|
Tests that the `copy` module always uses the same instance of Absent.
|
|
"""
|
|
|
|
class MyModel(BaseModel):
|
|
absent: AbsentType = Absent
|
|
|
|
a = MyModel.model_validate({})
|
|
b = copy.deepcopy(a)
|
|
|
|
self.assertIs(copy.copy(Absent), Absent)
|
|
self.assertIs(a.absent, b.absent)
|
|
|
|
|
|
class NonNegativeStrictIntTestCase(unittest.TestCase):
|
|
"""
|
|
Tests for the `NonNegativeStrictInt` utility.
|
|
"""
|
|
|
|
def test_pydantic_jsonschema(self) -> None:
|
|
"""
|
|
Tests that `NonNegativeStrictInt` produces sensible JSONSchema.
|
|
"""
|
|
|
|
class MyModel(BaseModel):
|
|
limit: NonNegativeStrictInt = 100
|
|
|
|
self.assertEqual(
|
|
MyModel.model_json_schema(),
|
|
{
|
|
"properties": {
|
|
"limit": {
|
|
"default": 100,
|
|
"minimum": 0,
|
|
"title": "Limit",
|
|
"type": "integer",
|
|
}
|
|
},
|
|
"title": "MyModel",
|
|
"type": "object",
|
|
},
|
|
f"JSONSchema actually is:\n{MyModel.model_json_schema()!r}",
|
|
)
|
|
|
|
def test_pydantic_reject(self) -> None:
|
|
"""
|
|
Tests that `NonNegativeStrictInt` rejects negative numbers
|
|
and non-ints.
|
|
"""
|
|
|
|
class MyModel(BaseModel):
|
|
limit: NonNegativeStrictInt = 100
|
|
|
|
with self.assertRaises(ValidationError):
|
|
MyModel.model_validate({"limit": -1})
|
|
|
|
with self.assertRaises(ValidationError):
|
|
MyModel.model_validate_json('{"limit": -1}')
|
|
|
|
# StrictInt, so don't accept floats...
|
|
with self.assertRaises(ValidationError):
|
|
MyModel.model_validate({"limit": 1.5})
|
|
|
|
with self.assertRaises(ValidationError):
|
|
MyModel.model_validate_json('{"limit": 1.5}')
|
|
|
|
# ...and don't accept stringy ints either.
|
|
with self.assertRaises(ValidationError):
|
|
MyModel.model_validate({"limit": "42"})
|
|
|
|
with self.assertRaises(ValidationError):
|
|
MyModel.model_validate_json('{"limit": "42"}')
|
|
|
|
def test_pydantic_accept(self) -> None:
|
|
"""
|
|
Tests that `Absent` accepts the absence of a value when used in Pydantic models.
|
|
"""
|
|
|
|
class MyModel(BaseModel):
|
|
limit: NonNegativeStrictInt = 100
|
|
|
|
self.assertEqual(MyModel.model_validate_json('{"limit": 0}'), MyModel(limit=0))
|
|
self.assertEqual(MyModel.model_validate({"limit": 42}), MyModel(limit=42))
|