|
@@ -12,14 +12,18 @@
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
# See the License for the specific language governing permissions and
|
|
|
# limitations under the License.
|
|
|
-
|
|
|
+from typing import Any, Awaitable, Callable, Dict
|
|
|
from unittest.mock import Mock
|
|
|
|
|
|
+from twisted.test.proto_helpers import MemoryReactor
|
|
|
+
|
|
|
import synapse.api.errors
|
|
|
import synapse.rest.admin
|
|
|
from synapse.api.constants import EventTypes
|
|
|
from synapse.rest.client import directory, login, room
|
|
|
-from synapse.types import RoomAlias, create_requester
|
|
|
+from synapse.server import HomeServer
|
|
|
+from synapse.types import JsonDict, RoomAlias, create_requester
|
|
|
+from synapse.util import Clock
|
|
|
|
|
|
from tests import unittest
|
|
|
from tests.test_utils import make_awaitable
|
|
@@ -28,13 +32,15 @@ from tests.test_utils import make_awaitable
|
|
|
class DirectoryTestCase(unittest.HomeserverTestCase):
|
|
|
"""Tests the directory service."""
|
|
|
|
|
|
- def make_homeserver(self, reactor, clock):
|
|
|
+ def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
|
|
|
self.mock_federation = Mock()
|
|
|
self.mock_registry = Mock()
|
|
|
|
|
|
- self.query_handlers = {}
|
|
|
+ self.query_handlers: Dict[str, Callable[[dict], Awaitable[JsonDict]]] = {}
|
|
|
|
|
|
- def register_query_handler(query_type, handler):
|
|
|
+ def register_query_handler(
|
|
|
+ query_type: str, handler: Callable[[dict], Awaitable[JsonDict]]
|
|
|
+ ) -> None:
|
|
|
self.query_handlers[query_type] = handler
|
|
|
|
|
|
self.mock_registry.register_query_handler = register_query_handler
|
|
@@ -54,7 +60,7 @@ class DirectoryTestCase(unittest.HomeserverTestCase):
|
|
|
|
|
|
return hs
|
|
|
|
|
|
- def test_get_local_association(self):
|
|
|
+ def test_get_local_association(self) -> None:
|
|
|
self.get_success(
|
|
|
self.store.create_room_alias_association(
|
|
|
self.my_room, "!8765qwer:test", ["test"]
|
|
@@ -65,7 +71,7 @@ class DirectoryTestCase(unittest.HomeserverTestCase):
|
|
|
|
|
|
self.assertEqual({"room_id": "!8765qwer:test", "servers": ["test"]}, result)
|
|
|
|
|
|
- def test_get_remote_association(self):
|
|
|
+ def test_get_remote_association(self) -> None:
|
|
|
self.mock_federation.make_query.return_value = make_awaitable(
|
|
|
{"room_id": "!8765qwer:test", "servers": ["test", "remote"]}
|
|
|
)
|
|
@@ -83,7 +89,7 @@ class DirectoryTestCase(unittest.HomeserverTestCase):
|
|
|
ignore_backoff=True,
|
|
|
)
|
|
|
|
|
|
- def test_incoming_fed_query(self):
|
|
|
+ def test_incoming_fed_query(self) -> None:
|
|
|
self.get_success(
|
|
|
self.store.create_room_alias_association(
|
|
|
self.your_room, "!8765asdf:test", ["test"]
|
|
@@ -105,7 +111,7 @@ class TestCreateAlias(unittest.HomeserverTestCase):
|
|
|
directory.register_servlets,
|
|
|
]
|
|
|
|
|
|
- def prepare(self, reactor, clock, hs):
|
|
|
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
|
self.handler = hs.get_directory_handler()
|
|
|
|
|
|
# Create user
|
|
@@ -125,7 +131,7 @@ class TestCreateAlias(unittest.HomeserverTestCase):
|
|
|
self.test_user_tok = self.login("user", "pass")
|
|
|
self.helper.join(room=self.room_id, user=self.test_user, tok=self.test_user_tok)
|
|
|
|
|
|
- def test_create_alias_joined_room(self):
|
|
|
+ def test_create_alias_joined_room(self) -> None:
|
|
|
"""A user can create an alias for a room they're in."""
|
|
|
self.get_success(
|
|
|
self.handler.create_association(
|
|
@@ -135,7 +141,7 @@ class TestCreateAlias(unittest.HomeserverTestCase):
|
|
|
)
|
|
|
)
|
|
|
|
|
|
- def test_create_alias_other_room(self):
|
|
|
+ def test_create_alias_other_room(self) -> None:
|
|
|
"""A user cannot create an alias for a room they're NOT in."""
|
|
|
other_room_id = self.helper.create_room_as(
|
|
|
self.admin_user, tok=self.admin_user_tok
|
|
@@ -150,7 +156,7 @@ class TestCreateAlias(unittest.HomeserverTestCase):
|
|
|
synapse.api.errors.SynapseError,
|
|
|
)
|
|
|
|
|
|
- def test_create_alias_admin(self):
|
|
|
+ def test_create_alias_admin(self) -> None:
|
|
|
"""An admin can create an alias for a room they're NOT in."""
|
|
|
other_room_id = self.helper.create_room_as(
|
|
|
self.test_user, tok=self.test_user_tok
|
|
@@ -173,7 +179,7 @@ class TestDeleteAlias(unittest.HomeserverTestCase):
|
|
|
directory.register_servlets,
|
|
|
]
|
|
|
|
|
|
- def prepare(self, reactor, clock, hs):
|
|
|
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
|
self.store = hs.get_datastores().main
|
|
|
self.handler = hs.get_directory_handler()
|
|
|
self.state_handler = hs.get_state_handler()
|
|
@@ -195,7 +201,7 @@ class TestDeleteAlias(unittest.HomeserverTestCase):
|
|
|
self.test_user_tok = self.login("user", "pass")
|
|
|
self.helper.join(room=self.room_id, user=self.test_user, tok=self.test_user_tok)
|
|
|
|
|
|
- def _create_alias(self, user):
|
|
|
+ def _create_alias(self, user) -> None:
|
|
|
# Create a new alias to this room.
|
|
|
self.get_success(
|
|
|
self.store.create_room_alias_association(
|
|
@@ -203,7 +209,7 @@ class TestDeleteAlias(unittest.HomeserverTestCase):
|
|
|
)
|
|
|
)
|
|
|
|
|
|
- def test_delete_alias_not_allowed(self):
|
|
|
+ def test_delete_alias_not_allowed(self) -> None:
|
|
|
"""A user that doesn't meet the expected guidelines cannot delete an alias."""
|
|
|
self._create_alias(self.admin_user)
|
|
|
self.get_failure(
|
|
@@ -213,7 +219,7 @@ class TestDeleteAlias(unittest.HomeserverTestCase):
|
|
|
synapse.api.errors.AuthError,
|
|
|
)
|
|
|
|
|
|
- def test_delete_alias_creator(self):
|
|
|
+ def test_delete_alias_creator(self) -> None:
|
|
|
"""An alias creator can delete their own alias."""
|
|
|
# Create an alias from a different user.
|
|
|
self._create_alias(self.test_user)
|
|
@@ -232,7 +238,7 @@ class TestDeleteAlias(unittest.HomeserverTestCase):
|
|
|
synapse.api.errors.SynapseError,
|
|
|
)
|
|
|
|
|
|
- def test_delete_alias_admin(self):
|
|
|
+ def test_delete_alias_admin(self) -> None:
|
|
|
"""A server admin can delete an alias created by another user."""
|
|
|
# Create an alias from a different user.
|
|
|
self._create_alias(self.test_user)
|
|
@@ -251,7 +257,7 @@ class TestDeleteAlias(unittest.HomeserverTestCase):
|
|
|
synapse.api.errors.SynapseError,
|
|
|
)
|
|
|
|
|
|
- def test_delete_alias_sufficient_power(self):
|
|
|
+ def test_delete_alias_sufficient_power(self) -> None:
|
|
|
"""A user with a sufficient power level should be able to delete an alias."""
|
|
|
self._create_alias(self.admin_user)
|
|
|
|
|
@@ -288,7 +294,7 @@ class CanonicalAliasTestCase(unittest.HomeserverTestCase):
|
|
|
directory.register_servlets,
|
|
|
]
|
|
|
|
|
|
- def prepare(self, reactor, clock, hs):
|
|
|
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
|
self.store = hs.get_datastores().main
|
|
|
self.handler = hs.get_directory_handler()
|
|
|
self.state_handler = hs.get_state_handler()
|
|
@@ -317,7 +323,7 @@ class CanonicalAliasTestCase(unittest.HomeserverTestCase):
|
|
|
)
|
|
|
return room_alias
|
|
|
|
|
|
- def _set_canonical_alias(self, content):
|
|
|
+ def _set_canonical_alias(self, content) -> None:
|
|
|
"""Configure the canonical alias state on the room."""
|
|
|
self.helper.send_state(
|
|
|
self.room_id,
|
|
@@ -334,7 +340,7 @@ class CanonicalAliasTestCase(unittest.HomeserverTestCase):
|
|
|
)
|
|
|
)
|
|
|
|
|
|
- def test_remove_alias(self):
|
|
|
+ def test_remove_alias(self) -> None:
|
|
|
"""Removing an alias that is the canonical alias should remove it there too."""
|
|
|
# Set this new alias as the canonical alias for this room
|
|
|
self._set_canonical_alias(
|
|
@@ -356,7 +362,7 @@ class CanonicalAliasTestCase(unittest.HomeserverTestCase):
|
|
|
self.assertNotIn("alias", data["content"])
|
|
|
self.assertNotIn("alt_aliases", data["content"])
|
|
|
|
|
|
- def test_remove_other_alias(self):
|
|
|
+ def test_remove_other_alias(self) -> None:
|
|
|
"""Removing an alias listed as in alt_aliases should remove it there too."""
|
|
|
# Create a second alias.
|
|
|
other_test_alias = "#test2:test"
|
|
@@ -393,7 +399,7 @@ class TestCreateAliasACL(unittest.HomeserverTestCase):
|
|
|
|
|
|
servlets = [directory.register_servlets, room.register_servlets]
|
|
|
|
|
|
- def default_config(self):
|
|
|
+ def default_config(self) -> Dict[str, Any]:
|
|
|
config = super().default_config()
|
|
|
|
|
|
# Add custom alias creation rules to the config.
|
|
@@ -403,7 +409,7 @@ class TestCreateAliasACL(unittest.HomeserverTestCase):
|
|
|
|
|
|
return config
|
|
|
|
|
|
- def test_denied(self):
|
|
|
+ def test_denied(self) -> None:
|
|
|
room_id = self.helper.create_room_as(self.user_id)
|
|
|
|
|
|
channel = self.make_request(
|
|
@@ -413,7 +419,7 @@ class TestCreateAliasACL(unittest.HomeserverTestCase):
|
|
|
)
|
|
|
self.assertEqual(403, channel.code, channel.result)
|
|
|
|
|
|
- def test_allowed(self):
|
|
|
+ def test_allowed(self) -> None:
|
|
|
room_id = self.helper.create_room_as(self.user_id)
|
|
|
|
|
|
channel = self.make_request(
|
|
@@ -423,7 +429,7 @@ class TestCreateAliasACL(unittest.HomeserverTestCase):
|
|
|
)
|
|
|
self.assertEqual(200, channel.code, channel.result)
|
|
|
|
|
|
- def test_denied_during_creation(self):
|
|
|
+ def test_denied_during_creation(self) -> None:
|
|
|
"""A room alias that is not allowed should be rejected during creation."""
|
|
|
# Invalid room alias.
|
|
|
self.helper.create_room_as(
|
|
@@ -432,7 +438,7 @@ class TestCreateAliasACL(unittest.HomeserverTestCase):
|
|
|
extra_content={"room_alias_name": "foo"},
|
|
|
)
|
|
|
|
|
|
- def test_allowed_during_creation(self):
|
|
|
+ def test_allowed_during_creation(self) -> None:
|
|
|
"""A valid room alias should be allowed during creation."""
|
|
|
room_id = self.helper.create_room_as(
|
|
|
self.user_id,
|
|
@@ -459,7 +465,7 @@ class TestCreatePublishedRoomACL(unittest.HomeserverTestCase):
|
|
|
data = {"room_alias_name": "unofficial_test"}
|
|
|
allowed_localpart = "allowed"
|
|
|
|
|
|
- def default_config(self):
|
|
|
+ def default_config(self) -> Dict[str, Any]:
|
|
|
config = super().default_config()
|
|
|
|
|
|
# Add custom room list publication rules to the config.
|
|
@@ -474,7 +480,9 @@ class TestCreatePublishedRoomACL(unittest.HomeserverTestCase):
|
|
|
|
|
|
return config
|
|
|
|
|
|
- def prepare(self, reactor, clock, hs):
|
|
|
+ def prepare(
|
|
|
+ self, reactor: MemoryReactor, clock: Clock, hs: HomeServer
|
|
|
+ ) -> HomeServer:
|
|
|
self.allowed_user_id = self.register_user(self.allowed_localpart, "pass")
|
|
|
self.allowed_access_token = self.login(self.allowed_localpart, "pass")
|
|
|
|
|
@@ -483,7 +491,7 @@ class TestCreatePublishedRoomACL(unittest.HomeserverTestCase):
|
|
|
|
|
|
return hs
|
|
|
|
|
|
- def test_denied_without_publication_permission(self):
|
|
|
+ def test_denied_without_publication_permission(self) -> None:
|
|
|
"""
|
|
|
Try to create a room, register an alias for it, and publish it,
|
|
|
as a user without permission to publish rooms.
|
|
@@ -497,7 +505,7 @@ class TestCreatePublishedRoomACL(unittest.HomeserverTestCase):
|
|
|
expect_code=403,
|
|
|
)
|
|
|
|
|
|
- def test_allowed_when_creating_private_room(self):
|
|
|
+ def test_allowed_when_creating_private_room(self) -> None:
|
|
|
"""
|
|
|
Try to create a room, register an alias for it, and NOT publish it,
|
|
|
as a user without permission to publish rooms.
|
|
@@ -511,7 +519,7 @@ class TestCreatePublishedRoomACL(unittest.HomeserverTestCase):
|
|
|
expect_code=200,
|
|
|
)
|
|
|
|
|
|
- def test_allowed_with_publication_permission(self):
|
|
|
+ def test_allowed_with_publication_permission(self) -> None:
|
|
|
"""
|
|
|
Try to create a room, register an alias for it, and publish it,
|
|
|
as a user WITH permission to publish rooms.
|
|
@@ -525,7 +533,7 @@ class TestCreatePublishedRoomACL(unittest.HomeserverTestCase):
|
|
|
expect_code=200,
|
|
|
)
|
|
|
|
|
|
- def test_denied_publication_with_invalid_alias(self):
|
|
|
+ def test_denied_publication_with_invalid_alias(self) -> None:
|
|
|
"""
|
|
|
Try to create a room, register an alias for it, and publish it,
|
|
|
as a user WITH permission to publish rooms.
|
|
@@ -538,7 +546,7 @@ class TestCreatePublishedRoomACL(unittest.HomeserverTestCase):
|
|
|
expect_code=403,
|
|
|
)
|
|
|
|
|
|
- def test_can_create_as_private_room_after_rejection(self):
|
|
|
+ def test_can_create_as_private_room_after_rejection(self) -> None:
|
|
|
"""
|
|
|
After failing to publish a room with an alias as a user without publish permission,
|
|
|
retry as the same user, but without publishing the room.
|
|
@@ -549,7 +557,7 @@ class TestCreatePublishedRoomACL(unittest.HomeserverTestCase):
|
|
|
self.test_denied_without_publication_permission()
|
|
|
self.test_allowed_when_creating_private_room()
|
|
|
|
|
|
- def test_can_create_with_permission_after_rejection(self):
|
|
|
+ def test_can_create_with_permission_after_rejection(self) -> None:
|
|
|
"""
|
|
|
After failing to publish a room with an alias as a user without publish permission,
|
|
|
retry as someone with permission, using the same alias.
|
|
@@ -566,7 +574,9 @@ class TestRoomListSearchDisabled(unittest.HomeserverTestCase):
|
|
|
|
|
|
servlets = [directory.register_servlets, room.register_servlets]
|
|
|
|
|
|
- def prepare(self, reactor, clock, hs):
|
|
|
+ def prepare(
|
|
|
+ self, reactor: MemoryReactor, clock: Clock, hs: HomeServer
|
|
|
+ ) -> HomeServer:
|
|
|
room_id = self.helper.create_room_as(self.user_id)
|
|
|
|
|
|
channel = self.make_request(
|
|
@@ -579,7 +589,7 @@ class TestRoomListSearchDisabled(unittest.HomeserverTestCase):
|
|
|
|
|
|
return hs
|
|
|
|
|
|
- def test_disabling_room_list(self):
|
|
|
+ def test_disabling_room_list(self) -> None:
|
|
|
self.room_list_handler.enable_room_list_search = True
|
|
|
self.directory_handler.enable_room_list_search = True
|
|
|
|