synapse/tests/handlers/test_directory.py

197 lines
6.6 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# 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 mock import Mock
2018-07-09 08:09:20 +02:00
from twisted.internet import defer
2018-10-18 17:14:41 +02:00
from synapse.config.room_directory import RoomDirectoryConfig
from synapse.handlers.directory import DirectoryHandler
2018-10-18 17:14:41 +02:00
from synapse.rest.client.v1 import directory, room
from synapse.types import RoomAlias
2018-07-09 08:09:20 +02:00
from tests import unittest
from tests.utils import setup_test_homeserver
class DirectoryHandlers(object):
def __init__(self, hs):
self.directory_handler = DirectoryHandler(hs)
class DirectoryTestCase(unittest.TestCase):
""" Tests the directory service. """
@defer.inlineCallbacks
def setUp(self):
2018-03-13 11:39:19 +01:00
self.mock_federation = Mock()
self.mock_registry = Mock()
self.query_handlers = {}
2014-11-04 17:35:38 +01:00
def register_query_handler(query_type, handler):
self.query_handlers[query_type] = handler
2018-08-10 15:54:09 +02:00
2018-03-13 11:39:19 +01:00
self.mock_registry.register_query_handler = register_query_handler
hs = yield setup_test_homeserver(
2018-08-13 08:47:46 +02:00
self.addCleanup,
http_client=None,
resource_for_federation=Mock(),
federation_client=self.mock_federation,
2018-03-13 11:39:19 +01:00
federation_registry=self.mock_registry,
)
hs.handlers = DirectoryHandlers(hs)
self.handler = hs.get_handlers().directory_handler
self.store = hs.get_datastore()
self.my_room = RoomAlias.from_string("#my-room:test")
self.your_room = RoomAlias.from_string("#your-room:test")
self.remote_room = RoomAlias.from_string("#another:remote")
@defer.inlineCallbacks
def test_get_local_association(self):
yield self.store.create_room_alias_association(
self.my_room, "!8765qwer:test", ["test"]
)
result = yield self.handler.get_association(self.my_room)
2018-08-10 15:54:09 +02:00
self.assertEquals({"room_id": "!8765qwer:test", "servers": ["test"]}, result)
@defer.inlineCallbacks
def test_get_remote_association(self):
self.mock_federation.make_query.return_value = defer.succeed(
{"room_id": "!8765qwer:test", "servers": ["test", "remote"]}
)
result = yield self.handler.get_association(self.remote_room)
2018-08-10 15:54:09 +02:00
self.assertEquals(
{"room_id": "!8765qwer:test", "servers": ["test", "remote"]}, result
)
self.mock_federation.make_query.assert_called_with(
destination="remote",
query_type="directory",
2018-08-10 15:54:09 +02:00
args={"room_alias": "#another:remote"},
retry_on_dns_fail=False,
2017-03-23 14:20:08 +01:00
ignore_backoff=True,
)
@defer.inlineCallbacks
def test_incoming_fed_query(self):
yield self.store.create_room_alias_association(
self.your_room, "!8765asdf:test", ["test"]
)
response = yield self.query_handlers["directory"](
{"room_alias": "#your-room:test"}
)
2018-08-10 15:54:09 +02:00
self.assertEquals({"room_id": "!8765asdf:test", "servers": ["test"]}, response)
2018-10-18 17:14:41 +02:00
class TestCreateAliasACL(unittest.HomeserverTestCase):
user_id = "@test:test"
servlets = [directory.register_servlets, room.register_servlets]
2019-03-20 15:53:44 +01:00
def prepare(self, reactor, clock, hs):
2018-10-18 17:14:41 +02:00
# We cheekily override the config to add custom alias creation rules
config = {}
config["alias_creation_rules"] = [
2019-05-10 07:12:11 +02:00
{"user_id": "*", "alias": "#unofficial_*", "action": "allow"}
2018-10-18 17:14:41 +02:00
]
config["room_list_publication_rules"] = []
2018-10-18 17:14:41 +02:00
rd_config = RoomDirectoryConfig()
rd_config.read_config(config)
self.hs.config.is_alias_creation_allowed = rd_config.is_alias_creation_allowed
return hs
def test_denied(self):
room_id = self.helper.create_room_as(self.user_id)
request, channel = self.make_request(
"PUT",
b"directory/room/%23test%3Atest",
('{"room_id":"%s"}' % (room_id,)).encode('ascii'),
)
self.render(request)
self.assertEquals(403, channel.code, channel.result)
def test_allowed(self):
room_id = self.helper.create_room_as(self.user_id)
request, channel = self.make_request(
"PUT",
b"directory/room/%23unofficial_test%3Atest",
('{"room_id":"%s"}' % (room_id,)).encode('ascii'),
)
self.render(request)
self.assertEquals(200, channel.code, channel.result)
2019-03-20 15:53:44 +01:00
class TestRoomListSearchDisabled(unittest.HomeserverTestCase):
user_id = "@test:test"
servlets = [directory.register_servlets, room.register_servlets]
def prepare(self, reactor, clock, hs):
room_id = self.helper.create_room_as(self.user_id)
request, channel = self.make_request(
2019-05-10 07:12:11 +02:00
"PUT", b"directory/list/room/%s" % (room_id.encode('ascii'),), b'{}'
2019-03-20 15:53:44 +01:00
)
self.render(request)
self.assertEquals(200, channel.code, channel.result)
self.room_list_handler = hs.get_room_list_handler()
self.directory_handler = hs.get_handlers().directory_handler
return hs
def test_disabling_room_list(self):
self.room_list_handler.enable_room_list_search = True
self.directory_handler.enable_room_list_search = True
# Room list is enabled so we should get some results
2019-05-10 07:12:11 +02:00
request, channel = self.make_request("GET", b"publicRooms")
2019-03-20 15:53:44 +01:00
self.render(request)
self.assertEquals(200, channel.code, channel.result)
self.assertTrue(len(channel.json_body["chunk"]) > 0)
self.room_list_handler.enable_room_list_search = False
self.directory_handler.enable_room_list_search = False
# Room list disabled so we should get no results
2019-05-10 07:12:11 +02:00
request, channel = self.make_request("GET", b"publicRooms")
2019-03-20 15:53:44 +01:00
self.render(request)
self.assertEquals(200, channel.code, channel.result)
self.assertTrue(len(channel.json_body["chunk"]) == 0)
# Room list disabled so we shouldn't be allowed to publish rooms
room_id = self.helper.create_room_as(self.user_id)
request, channel = self.make_request(
2019-05-10 07:12:11 +02:00
"PUT", b"directory/list/room/%s" % (room_id.encode('ascii'),), b'{}'
2019-03-20 15:53:44 +01:00
)
self.render(request)
self.assertEquals(403, channel.code, channel.result)