mirror of
https://mau.dev/maunium/synapse.git
synced 2024-09-28 20:48:58 +02:00
ebad618bf0
This PR changes `from pydantic import BaseModel` to `from synapse._pydantic_compat import BaseModel` (as well as `constr`, `conbytes`, `conint`, `confloat`). It allows `check_pydantic_models.py` to mock those pydantic objects only in the synapse module, and not interfere with pydantic objects in external dependencies. This should solve the CI problems for #17144, which breaks because `check_pydantic_models.py` patches pydantic models from [scim2-models](https://scim2-models.readthedocs.io/). /cc @DMRobertson @gotmax23 fixes #17659 ### Pull Request Checklist <!-- Please read https://element-hq.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request --> * [x] Pull request is based on the develop branch * [x] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [x] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
83 lines
2.8 KiB
Python
83 lines
2.8 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
# 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 unittest as stdlib_unittest
|
|
|
|
from typing_extensions import Literal
|
|
|
|
from synapse._pydantic_compat import BaseModel, ValidationError
|
|
from synapse.types.rest.client import EmailRequestTokenBody
|
|
|
|
|
|
class ThreepidMediumEnumTestCase(stdlib_unittest.TestCase):
|
|
class Model(BaseModel):
|
|
medium: Literal["email", "msisdn"]
|
|
|
|
def test_accepts_valid_medium_string(self) -> None:
|
|
"""Sanity check that Pydantic behaves sensibly with an enum-of-str
|
|
|
|
This is arguably more of a test of a class that inherits from str and Enum
|
|
simultaneously.
|
|
"""
|
|
model = self.Model.parse_obj({"medium": "email"})
|
|
self.assertEqual(model.medium, "email")
|
|
|
|
def test_rejects_invalid_medium_value(self) -> None:
|
|
with self.assertRaises(ValidationError):
|
|
self.Model.parse_obj({"medium": "interpretive_dance"})
|
|
|
|
def test_rejects_invalid_medium_type(self) -> None:
|
|
with self.assertRaises(ValidationError):
|
|
self.Model.parse_obj({"medium": 123})
|
|
|
|
|
|
class EmailRequestTokenBodyTestCase(stdlib_unittest.TestCase):
|
|
base_request = {
|
|
"client_secret": "hunter2",
|
|
"email": "alice@wonderland.com",
|
|
"send_attempt": 1,
|
|
}
|
|
|
|
def test_token_required_if_id_server_provided(self) -> None:
|
|
with self.assertRaises(ValidationError):
|
|
EmailRequestTokenBody.parse_obj(
|
|
{
|
|
**self.base_request,
|
|
"id_server": "identity.wonderland.com",
|
|
}
|
|
)
|
|
with self.assertRaises(ValidationError):
|
|
EmailRequestTokenBody.parse_obj(
|
|
{
|
|
**self.base_request,
|
|
"id_server": "identity.wonderland.com",
|
|
"id_access_token": None,
|
|
}
|
|
)
|
|
|
|
def test_token_typechecked_when_id_server_provided(self) -> None:
|
|
with self.assertRaises(ValidationError):
|
|
EmailRequestTokenBody.parse_obj(
|
|
{
|
|
**self.base_request,
|
|
"id_server": "identity.wonderland.com",
|
|
"id_access_token": 1337,
|
|
}
|
|
)
|