mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-26 22:59:24 -05:00
1606 lines
59 KiB
Python
1606 lines
59 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2020 Dirk Klimpel
|
|
#
|
|
# 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.
|
|
|
|
import json
|
|
import urllib.parse
|
|
from typing import List, Optional
|
|
|
|
from mock import Mock
|
|
|
|
import synapse.rest.admin
|
|
from synapse.api.constants import EventTypes, Membership
|
|
from synapse.api.errors import Codes
|
|
from synapse.rest.client.v1 import directory, events, login, room
|
|
|
|
from tests import unittest
|
|
|
|
"""Tests admin REST events for /rooms paths."""
|
|
|
|
|
|
class ShutdownRoomTestCase(unittest.HomeserverTestCase):
|
|
servlets = [
|
|
synapse.rest.admin.register_servlets_for_client_rest_resource,
|
|
login.register_servlets,
|
|
events.register_servlets,
|
|
room.register_servlets,
|
|
room.register_deprecated_servlets,
|
|
]
|
|
|
|
def prepare(self, reactor, clock, hs):
|
|
self.event_creation_handler = hs.get_event_creation_handler()
|
|
hs.config.user_consent_version = "1"
|
|
|
|
consent_uri_builder = Mock()
|
|
consent_uri_builder.build_user_consent_uri.return_value = "http://example.com"
|
|
self.event_creation_handler._consent_uri_builder = consent_uri_builder
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.admin_user = self.register_user("admin", "pass", admin=True)
|
|
self.admin_user_tok = self.login("admin", "pass")
|
|
|
|
self.other_user = self.register_user("user", "pass")
|
|
self.other_user_token = self.login("user", "pass")
|
|
|
|
# Mark the admin user as having consented
|
|
self.get_success(self.store.user_set_consent_version(self.admin_user, "1"))
|
|
|
|
def test_shutdown_room_consent(self):
|
|
"""Test that we can shutdown rooms with local users who have not
|
|
yet accepted the privacy policy. This used to fail when we tried to
|
|
force part the user from the old room.
|
|
"""
|
|
self.event_creation_handler._block_events_without_consent_error = None
|
|
|
|
room_id = self.helper.create_room_as(self.other_user, tok=self.other_user_token)
|
|
|
|
# Assert one user in room
|
|
users_in_room = self.get_success(self.store.get_users_in_room(room_id))
|
|
self.assertEqual([self.other_user], users_in_room)
|
|
|
|
# Enable require consent to send events
|
|
self.event_creation_handler._block_events_without_consent_error = "Error"
|
|
|
|
# Assert that the user is getting consent error
|
|
self.helper.send(
|
|
room_id, body="foo", tok=self.other_user_token, expect_code=403
|
|
)
|
|
|
|
# Test that the admin can still send shutdown
|
|
url = "/_synapse/admin/v1/shutdown_room/" + room_id
|
|
channel = self.make_request(
|
|
"POST",
|
|
url.encode("ascii"),
|
|
json.dumps({"new_room_user_id": self.admin_user}),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Assert there is now no longer anyone in the room
|
|
users_in_room = self.get_success(self.store.get_users_in_room(room_id))
|
|
self.assertEqual([], users_in_room)
|
|
|
|
def test_shutdown_room_block_peek(self):
|
|
"""Test that a world_readable room can no longer be peeked into after
|
|
it has been shut down.
|
|
"""
|
|
|
|
self.event_creation_handler._block_events_without_consent_error = None
|
|
|
|
room_id = self.helper.create_room_as(self.other_user, tok=self.other_user_token)
|
|
|
|
# Enable world readable
|
|
url = "rooms/%s/state/m.room.history_visibility" % (room_id,)
|
|
channel = self.make_request(
|
|
"PUT",
|
|
url.encode("ascii"),
|
|
json.dumps({"history_visibility": "world_readable"}),
|
|
access_token=self.other_user_token,
|
|
)
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Test that the admin can still send shutdown
|
|
url = "/_synapse/admin/v1/shutdown_room/" + room_id
|
|
channel = self.make_request(
|
|
"POST",
|
|
url.encode("ascii"),
|
|
json.dumps({"new_room_user_id": self.admin_user}),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Assert we can no longer peek into the room
|
|
self._assert_peek(room_id, expect_code=403)
|
|
|
|
def _assert_peek(self, room_id, expect_code):
|
|
"""Assert that the admin user can (or cannot) peek into the room.
|
|
"""
|
|
|
|
url = "rooms/%s/initialSync" % (room_id,)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok
|
|
)
|
|
self.assertEqual(
|
|
expect_code, int(channel.result["code"]), msg=channel.result["body"]
|
|
)
|
|
|
|
url = "events?timeout=0&room_id=" + room_id
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok
|
|
)
|
|
self.assertEqual(
|
|
expect_code, int(channel.result["code"]), msg=channel.result["body"]
|
|
)
|
|
|
|
|
|
class DeleteRoomTestCase(unittest.HomeserverTestCase):
|
|
servlets = [
|
|
synapse.rest.admin.register_servlets,
|
|
login.register_servlets,
|
|
events.register_servlets,
|
|
room.register_servlets,
|
|
room.register_deprecated_servlets,
|
|
]
|
|
|
|
def prepare(self, reactor, clock, hs):
|
|
self.event_creation_handler = hs.get_event_creation_handler()
|
|
hs.config.user_consent_version = "1"
|
|
|
|
consent_uri_builder = Mock()
|
|
consent_uri_builder.build_user_consent_uri.return_value = "http://example.com"
|
|
self.event_creation_handler._consent_uri_builder = consent_uri_builder
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.admin_user = self.register_user("admin", "pass", admin=True)
|
|
self.admin_user_tok = self.login("admin", "pass")
|
|
|
|
self.other_user = self.register_user("user", "pass")
|
|
self.other_user_tok = self.login("user", "pass")
|
|
|
|
# Mark the admin user as having consented
|
|
self.get_success(self.store.user_set_consent_version(self.admin_user, "1"))
|
|
|
|
self.room_id = self.helper.create_room_as(
|
|
self.other_user, tok=self.other_user_tok
|
|
)
|
|
self.url = "/_synapse/admin/v1/rooms/%s/delete" % self.room_id
|
|
|
|
def test_requester_is_no_admin(self):
|
|
"""
|
|
If the user is not a server admin, an error 403 is returned.
|
|
"""
|
|
|
|
channel = self.make_request(
|
|
"POST", self.url, json.dumps({}), access_token=self.other_user_tok,
|
|
)
|
|
|
|
self.assertEqual(403, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
|
|
|
|
def test_room_does_not_exist(self):
|
|
"""
|
|
Check that unknown rooms/server return error 404.
|
|
"""
|
|
url = "/_synapse/admin/v1/rooms/!unknown:test/delete"
|
|
|
|
channel = self.make_request(
|
|
"POST", url, json.dumps({}), access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(404, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(Codes.NOT_FOUND, channel.json_body["errcode"])
|
|
|
|
def test_room_is_not_valid(self):
|
|
"""
|
|
Check that invalid room names, return an error 400.
|
|
"""
|
|
url = "/_synapse/admin/v1/rooms/invalidroom/delete"
|
|
|
|
channel = self.make_request(
|
|
"POST", url, json.dumps({}), access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(
|
|
"invalidroom is not a legal room ID", channel.json_body["error"],
|
|
)
|
|
|
|
def test_new_room_user_does_not_exist(self):
|
|
"""
|
|
Tests that the user ID must be from local server but it does not have to exist.
|
|
"""
|
|
body = json.dumps({"new_room_user_id": "@unknown:test"})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertIn("new_room_id", channel.json_body)
|
|
self.assertIn("kicked_users", channel.json_body)
|
|
self.assertIn("failed_to_kick_users", channel.json_body)
|
|
self.assertIn("local_aliases", channel.json_body)
|
|
|
|
def test_new_room_user_is_not_local(self):
|
|
"""
|
|
Check that only local users can create new room to move members.
|
|
"""
|
|
body = json.dumps({"new_room_user_id": "@not:exist.bla"})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(
|
|
"User must be our own: @not:exist.bla", channel.json_body["error"],
|
|
)
|
|
|
|
def test_block_is_not_bool(self):
|
|
"""
|
|
If parameter `block` is not boolean, return an error
|
|
"""
|
|
body = json.dumps({"block": "NotBool"})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(Codes.BAD_JSON, channel.json_body["errcode"])
|
|
|
|
def test_purge_is_not_bool(self):
|
|
"""
|
|
If parameter `purge` is not boolean, return an error
|
|
"""
|
|
body = json.dumps({"purge": "NotBool"})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(Codes.BAD_JSON, channel.json_body["errcode"])
|
|
|
|
def test_purge_room_and_block(self):
|
|
"""Test to purge a room and block it.
|
|
Members will not be moved to a new room and will not receive a message.
|
|
"""
|
|
# Test that room is not purged
|
|
with self.assertRaises(AssertionError):
|
|
self._is_purged(self.room_id)
|
|
|
|
# Test that room is not blocked
|
|
self._is_blocked(self.room_id, expect=False)
|
|
|
|
# Assert one user in room
|
|
self._is_member(room_id=self.room_id, user_id=self.other_user)
|
|
|
|
body = json.dumps({"block": True, "purge": True})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url.encode("ascii"),
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(None, channel.json_body["new_room_id"])
|
|
self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
|
|
self.assertIn("failed_to_kick_users", channel.json_body)
|
|
self.assertIn("local_aliases", channel.json_body)
|
|
|
|
self._is_purged(self.room_id)
|
|
self._is_blocked(self.room_id, expect=True)
|
|
self._has_no_members(self.room_id)
|
|
|
|
def test_purge_room_and_not_block(self):
|
|
"""Test to purge a room and do not block it.
|
|
Members will not be moved to a new room and will not receive a message.
|
|
"""
|
|
# Test that room is not purged
|
|
with self.assertRaises(AssertionError):
|
|
self._is_purged(self.room_id)
|
|
|
|
# Test that room is not blocked
|
|
self._is_blocked(self.room_id, expect=False)
|
|
|
|
# Assert one user in room
|
|
self._is_member(room_id=self.room_id, user_id=self.other_user)
|
|
|
|
body = json.dumps({"block": False, "purge": True})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url.encode("ascii"),
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(None, channel.json_body["new_room_id"])
|
|
self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
|
|
self.assertIn("failed_to_kick_users", channel.json_body)
|
|
self.assertIn("local_aliases", channel.json_body)
|
|
|
|
self._is_purged(self.room_id)
|
|
self._is_blocked(self.room_id, expect=False)
|
|
self._has_no_members(self.room_id)
|
|
|
|
def test_block_room_and_not_purge(self):
|
|
"""Test to block a room without purging it.
|
|
Members will not be moved to a new room and will not receive a message.
|
|
The room will not be purged.
|
|
"""
|
|
# Test that room is not purged
|
|
with self.assertRaises(AssertionError):
|
|
self._is_purged(self.room_id)
|
|
|
|
# Test that room is not blocked
|
|
self._is_blocked(self.room_id, expect=False)
|
|
|
|
# Assert one user in room
|
|
self._is_member(room_id=self.room_id, user_id=self.other_user)
|
|
|
|
body = json.dumps({"block": False, "purge": False})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url.encode("ascii"),
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(None, channel.json_body["new_room_id"])
|
|
self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
|
|
self.assertIn("failed_to_kick_users", channel.json_body)
|
|
self.assertIn("local_aliases", channel.json_body)
|
|
|
|
with self.assertRaises(AssertionError):
|
|
self._is_purged(self.room_id)
|
|
self._is_blocked(self.room_id, expect=False)
|
|
self._has_no_members(self.room_id)
|
|
|
|
def test_shutdown_room_consent(self):
|
|
"""Test that we can shutdown rooms with local users who have not
|
|
yet accepted the privacy policy. This used to fail when we tried to
|
|
force part the user from the old room.
|
|
Members will be moved to a new room and will receive a message.
|
|
"""
|
|
self.event_creation_handler._block_events_without_consent_error = None
|
|
|
|
# Assert one user in room
|
|
users_in_room = self.get_success(self.store.get_users_in_room(self.room_id))
|
|
self.assertEqual([self.other_user], users_in_room)
|
|
|
|
# Enable require consent to send events
|
|
self.event_creation_handler._block_events_without_consent_error = "Error"
|
|
|
|
# Assert that the user is getting consent error
|
|
self.helper.send(
|
|
self.room_id, body="foo", tok=self.other_user_tok, expect_code=403
|
|
)
|
|
|
|
# Test that room is not purged
|
|
with self.assertRaises(AssertionError):
|
|
self._is_purged(self.room_id)
|
|
|
|
# Assert one user in room
|
|
self._is_member(room_id=self.room_id, user_id=self.other_user)
|
|
|
|
# Test that the admin can still send shutdown
|
|
url = "/_synapse/admin/v1/rooms/%s/delete" % self.room_id
|
|
channel = self.make_request(
|
|
"POST",
|
|
url.encode("ascii"),
|
|
json.dumps({"new_room_user_id": self.admin_user}),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
|
|
self.assertIn("new_room_id", channel.json_body)
|
|
self.assertIn("failed_to_kick_users", channel.json_body)
|
|
self.assertIn("local_aliases", channel.json_body)
|
|
|
|
# Test that member has moved to new room
|
|
self._is_member(
|
|
room_id=channel.json_body["new_room_id"], user_id=self.other_user
|
|
)
|
|
|
|
self._is_purged(self.room_id)
|
|
self._has_no_members(self.room_id)
|
|
|
|
def test_shutdown_room_block_peek(self):
|
|
"""Test that a world_readable room can no longer be peeked into after
|
|
it has been shut down.
|
|
Members will be moved to a new room and will receive a message.
|
|
"""
|
|
self.event_creation_handler._block_events_without_consent_error = None
|
|
|
|
# Enable world readable
|
|
url = "rooms/%s/state/m.room.history_visibility" % (self.room_id,)
|
|
channel = self.make_request(
|
|
"PUT",
|
|
url.encode("ascii"),
|
|
json.dumps({"history_visibility": "world_readable"}),
|
|
access_token=self.other_user_tok,
|
|
)
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Test that room is not purged
|
|
with self.assertRaises(AssertionError):
|
|
self._is_purged(self.room_id)
|
|
|
|
# Assert one user in room
|
|
self._is_member(room_id=self.room_id, user_id=self.other_user)
|
|
|
|
# Test that the admin can still send shutdown
|
|
url = "/_synapse/admin/v1/rooms/%s/delete" % self.room_id
|
|
channel = self.make_request(
|
|
"POST",
|
|
url.encode("ascii"),
|
|
json.dumps({"new_room_user_id": self.admin_user}),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
|
|
self.assertIn("new_room_id", channel.json_body)
|
|
self.assertIn("failed_to_kick_users", channel.json_body)
|
|
self.assertIn("local_aliases", channel.json_body)
|
|
|
|
# Test that member has moved to new room
|
|
self._is_member(
|
|
room_id=channel.json_body["new_room_id"], user_id=self.other_user
|
|
)
|
|
|
|
self._is_purged(self.room_id)
|
|
self._has_no_members(self.room_id)
|
|
|
|
# Assert we can no longer peek into the room
|
|
self._assert_peek(self.room_id, expect_code=403)
|
|
|
|
def _is_blocked(self, room_id, expect=True):
|
|
"""Assert that the room is blocked or not
|
|
"""
|
|
d = self.store.is_room_blocked(room_id)
|
|
if expect:
|
|
self.assertTrue(self.get_success(d))
|
|
else:
|
|
self.assertIsNone(self.get_success(d))
|
|
|
|
def _has_no_members(self, room_id):
|
|
"""Assert there is now no longer anyone in the room
|
|
"""
|
|
users_in_room = self.get_success(self.store.get_users_in_room(room_id))
|
|
self.assertEqual([], users_in_room)
|
|
|
|
def _is_member(self, room_id, user_id):
|
|
"""Test that user is member of the room
|
|
"""
|
|
users_in_room = self.get_success(self.store.get_users_in_room(room_id))
|
|
self.assertIn(user_id, users_in_room)
|
|
|
|
def _is_purged(self, room_id):
|
|
"""Test that the following tables have been purged of all rows related to the room.
|
|
"""
|
|
for table in PURGE_TABLES:
|
|
count = self.get_success(
|
|
self.store.db_pool.simple_select_one_onecol(
|
|
table=table,
|
|
keyvalues={"room_id": room_id},
|
|
retcol="COUNT(*)",
|
|
desc="test_purge_room",
|
|
)
|
|
)
|
|
|
|
self.assertEqual(count, 0, msg="Rows not purged in {}".format(table))
|
|
|
|
def _assert_peek(self, room_id, expect_code):
|
|
"""Assert that the admin user can (or cannot) peek into the room.
|
|
"""
|
|
|
|
url = "rooms/%s/initialSync" % (room_id,)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok
|
|
)
|
|
self.assertEqual(
|
|
expect_code, int(channel.result["code"]), msg=channel.result["body"]
|
|
)
|
|
|
|
url = "events?timeout=0&room_id=" + room_id
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok
|
|
)
|
|
self.assertEqual(
|
|
expect_code, int(channel.result["code"]), msg=channel.result["body"]
|
|
)
|
|
|
|
|
|
class PurgeRoomTestCase(unittest.HomeserverTestCase):
|
|
"""Test /purge_room admin API.
|
|
"""
|
|
|
|
servlets = [
|
|
synapse.rest.admin.register_servlets,
|
|
login.register_servlets,
|
|
room.register_servlets,
|
|
]
|
|
|
|
def prepare(self, reactor, clock, hs):
|
|
self.store = hs.get_datastore()
|
|
|
|
self.admin_user = self.register_user("admin", "pass", admin=True)
|
|
self.admin_user_tok = self.login("admin", "pass")
|
|
|
|
def test_purge_room(self):
|
|
room_id = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
|
|
# All users have to have left the room.
|
|
self.helper.leave(room_id, user=self.admin_user, tok=self.admin_user_tok)
|
|
|
|
url = "/_synapse/admin/v1/purge_room"
|
|
channel = self.make_request(
|
|
"POST",
|
|
url.encode("ascii"),
|
|
{"room_id": room_id},
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Test that the following tables have been purged of all rows related to the room.
|
|
for table in PURGE_TABLES:
|
|
count = self.get_success(
|
|
self.store.db_pool.simple_select_one_onecol(
|
|
table=table,
|
|
keyvalues={"room_id": room_id},
|
|
retcol="COUNT(*)",
|
|
desc="test_purge_room",
|
|
)
|
|
)
|
|
|
|
self.assertEqual(count, 0, msg="Rows not purged in {}".format(table))
|
|
|
|
|
|
class RoomTestCase(unittest.HomeserverTestCase):
|
|
"""Test /room admin API.
|
|
"""
|
|
|
|
servlets = [
|
|
synapse.rest.admin.register_servlets,
|
|
login.register_servlets,
|
|
room.register_servlets,
|
|
directory.register_servlets,
|
|
]
|
|
|
|
def prepare(self, reactor, clock, hs):
|
|
self.store = hs.get_datastore()
|
|
|
|
# Create user
|
|
self.admin_user = self.register_user("admin", "pass", admin=True)
|
|
self.admin_user_tok = self.login("admin", "pass")
|
|
|
|
def test_list_rooms(self):
|
|
"""Test that we can list rooms"""
|
|
# Create 3 test rooms
|
|
total_rooms = 3
|
|
room_ids = []
|
|
for x in range(total_rooms):
|
|
room_id = self.helper.create_room_as(
|
|
self.admin_user, tok=self.admin_user_tok
|
|
)
|
|
room_ids.append(room_id)
|
|
|
|
# Request the list of rooms
|
|
url = "/_synapse/admin/v1/rooms"
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
|
|
# Check request completed successfully
|
|
self.assertEqual(200, int(channel.code), msg=channel.json_body)
|
|
|
|
# Check that response json body contains a "rooms" key
|
|
self.assertTrue(
|
|
"rooms" in channel.json_body,
|
|
msg="Response body does not " "contain a 'rooms' key",
|
|
)
|
|
|
|
# Check that 3 rooms were returned
|
|
self.assertEqual(3, len(channel.json_body["rooms"]), msg=channel.json_body)
|
|
|
|
# Check their room_ids match
|
|
returned_room_ids = [room["room_id"] for room in channel.json_body["rooms"]]
|
|
self.assertEqual(room_ids, returned_room_ids)
|
|
|
|
# Check that all fields are available
|
|
for r in channel.json_body["rooms"]:
|
|
self.assertIn("name", r)
|
|
self.assertIn("canonical_alias", r)
|
|
self.assertIn("joined_members", r)
|
|
self.assertIn("joined_local_members", r)
|
|
self.assertIn("version", r)
|
|
self.assertIn("creator", r)
|
|
self.assertIn("encryption", r)
|
|
self.assertIn("federatable", r)
|
|
self.assertIn("public", r)
|
|
self.assertIn("join_rules", r)
|
|
self.assertIn("guest_access", r)
|
|
self.assertIn("history_visibility", r)
|
|
self.assertIn("state_events", r)
|
|
|
|
# Check that the correct number of total rooms was returned
|
|
self.assertEqual(channel.json_body["total_rooms"], total_rooms)
|
|
|
|
# Check that the offset is correct
|
|
# Should be 0 as we aren't paginating
|
|
self.assertEqual(channel.json_body["offset"], 0)
|
|
|
|
# Check that the prev_batch parameter is not present
|
|
self.assertNotIn("prev_batch", channel.json_body)
|
|
|
|
# We shouldn't receive a next token here as there's no further rooms to show
|
|
self.assertNotIn("next_batch", channel.json_body)
|
|
|
|
def test_list_rooms_pagination(self):
|
|
"""Test that we can get a full list of rooms through pagination"""
|
|
# Create 5 test rooms
|
|
total_rooms = 5
|
|
room_ids = []
|
|
for x in range(total_rooms):
|
|
room_id = self.helper.create_room_as(
|
|
self.admin_user, tok=self.admin_user_tok
|
|
)
|
|
room_ids.append(room_id)
|
|
|
|
# Set the name of the rooms so we get a consistent returned ordering
|
|
for idx, room_id in enumerate(room_ids):
|
|
self.helper.send_state(
|
|
room_id, "m.room.name", {"name": str(idx)}, tok=self.admin_user_tok,
|
|
)
|
|
|
|
# Request the list of rooms
|
|
returned_room_ids = []
|
|
start = 0
|
|
limit = 2
|
|
|
|
run_count = 0
|
|
should_repeat = True
|
|
while should_repeat:
|
|
run_count += 1
|
|
|
|
url = "/_synapse/admin/v1/rooms?from=%d&limit=%d&order_by=%s" % (
|
|
start,
|
|
limit,
|
|
"name",
|
|
)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(
|
|
200, int(channel.result["code"]), msg=channel.result["body"]
|
|
)
|
|
|
|
self.assertTrue("rooms" in channel.json_body)
|
|
for r in channel.json_body["rooms"]:
|
|
returned_room_ids.append(r["room_id"])
|
|
|
|
# Check that the correct number of total rooms was returned
|
|
self.assertEqual(channel.json_body["total_rooms"], total_rooms)
|
|
|
|
# Check that the offset is correct
|
|
# We're only getting 2 rooms each page, so should be 2 * last run_count
|
|
self.assertEqual(channel.json_body["offset"], 2 * (run_count - 1))
|
|
|
|
if run_count > 1:
|
|
# Check the value of prev_batch is correct
|
|
self.assertEqual(channel.json_body["prev_batch"], 2 * (run_count - 2))
|
|
|
|
if "next_batch" not in channel.json_body:
|
|
# We have reached the end of the list
|
|
should_repeat = False
|
|
else:
|
|
# Make another query with an updated start value
|
|
start = channel.json_body["next_batch"]
|
|
|
|
# We should've queried the endpoint 3 times
|
|
self.assertEqual(
|
|
run_count,
|
|
3,
|
|
msg="Should've queried 3 times for 5 rooms with limit 2 per query",
|
|
)
|
|
|
|
# Check that we received all of the room ids
|
|
self.assertEqual(room_ids, returned_room_ids)
|
|
|
|
url = "/_synapse/admin/v1/rooms?from=%d&limit=%d" % (start, limit)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
def test_correct_room_attributes(self):
|
|
"""Test the correct attributes for a room are returned"""
|
|
# Create a test room
|
|
room_id = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
|
|
test_alias = "#test:test"
|
|
test_room_name = "something"
|
|
|
|
# Have another user join the room
|
|
user_2 = self.register_user("user4", "pass")
|
|
user_tok_2 = self.login("user4", "pass")
|
|
self.helper.join(room_id, user_2, tok=user_tok_2)
|
|
|
|
# Create a new alias to this room
|
|
url = "/_matrix/client/r0/directory/room/%s" % (urllib.parse.quote(test_alias),)
|
|
channel = self.make_request(
|
|
"PUT",
|
|
url.encode("ascii"),
|
|
{"room_id": room_id},
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Set this new alias as the canonical alias for this room
|
|
self.helper.send_state(
|
|
room_id,
|
|
"m.room.aliases",
|
|
{"aliases": [test_alias]},
|
|
tok=self.admin_user_tok,
|
|
state_key="test",
|
|
)
|
|
self.helper.send_state(
|
|
room_id,
|
|
"m.room.canonical_alias",
|
|
{"alias": test_alias},
|
|
tok=self.admin_user_tok,
|
|
)
|
|
|
|
# Set a name for the room
|
|
self.helper.send_state(
|
|
room_id, "m.room.name", {"name": test_room_name}, tok=self.admin_user_tok,
|
|
)
|
|
|
|
# Request the list of rooms
|
|
url = "/_synapse/admin/v1/rooms"
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Check that rooms were returned
|
|
self.assertTrue("rooms" in channel.json_body)
|
|
rooms = channel.json_body["rooms"]
|
|
|
|
# Check that only one room was returned
|
|
self.assertEqual(len(rooms), 1)
|
|
|
|
# And that the value of the total_rooms key was correct
|
|
self.assertEqual(channel.json_body["total_rooms"], 1)
|
|
|
|
# Check that the offset is correct
|
|
# We're not paginating, so should be 0
|
|
self.assertEqual(channel.json_body["offset"], 0)
|
|
|
|
# Check that there is no `prev_batch`
|
|
self.assertNotIn("prev_batch", channel.json_body)
|
|
|
|
# Check that there is no `next_batch`
|
|
self.assertNotIn("next_batch", channel.json_body)
|
|
|
|
# Check that all provided attributes are set
|
|
r = rooms[0]
|
|
self.assertEqual(room_id, r["room_id"])
|
|
self.assertEqual(test_room_name, r["name"])
|
|
self.assertEqual(test_alias, r["canonical_alias"])
|
|
|
|
def test_room_list_sort_order(self):
|
|
"""Test room list sort ordering. alphabetical name versus number of members,
|
|
reversing the order, etc.
|
|
"""
|
|
|
|
def _set_canonical_alias(room_id: str, test_alias: str, admin_user_tok: str):
|
|
# Create a new alias to this room
|
|
url = "/_matrix/client/r0/directory/room/%s" % (
|
|
urllib.parse.quote(test_alias),
|
|
)
|
|
channel = self.make_request(
|
|
"PUT",
|
|
url.encode("ascii"),
|
|
{"room_id": room_id},
|
|
access_token=admin_user_tok,
|
|
)
|
|
self.assertEqual(
|
|
200, int(channel.result["code"]), msg=channel.result["body"]
|
|
)
|
|
|
|
# Set this new alias as the canonical alias for this room
|
|
self.helper.send_state(
|
|
room_id,
|
|
"m.room.aliases",
|
|
{"aliases": [test_alias]},
|
|
tok=admin_user_tok,
|
|
state_key="test",
|
|
)
|
|
self.helper.send_state(
|
|
room_id,
|
|
"m.room.canonical_alias",
|
|
{"alias": test_alias},
|
|
tok=admin_user_tok,
|
|
)
|
|
|
|
def _order_test(
|
|
order_type: str, expected_room_list: List[str], reverse: bool = False,
|
|
):
|
|
"""Request the list of rooms in a certain order. Assert that order is what
|
|
we expect
|
|
|
|
Args:
|
|
order_type: The type of ordering to give the server
|
|
expected_room_list: The list of room_ids in the order we expect to get
|
|
back from the server
|
|
"""
|
|
# Request the list of rooms in the given order
|
|
url = "/_synapse/admin/v1/rooms?order_by=%s" % (order_type,)
|
|
if reverse:
|
|
url += "&dir=b"
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
|
|
# Check that rooms were returned
|
|
self.assertTrue("rooms" in channel.json_body)
|
|
rooms = channel.json_body["rooms"]
|
|
|
|
# Check for the correct total_rooms value
|
|
self.assertEqual(channel.json_body["total_rooms"], 3)
|
|
|
|
# Check that the offset is correct
|
|
# We're not paginating, so should be 0
|
|
self.assertEqual(channel.json_body["offset"], 0)
|
|
|
|
# Check that there is no `prev_batch`
|
|
self.assertNotIn("prev_batch", channel.json_body)
|
|
|
|
# Check that there is no `next_batch`
|
|
self.assertNotIn("next_batch", channel.json_body)
|
|
|
|
# Check that rooms were returned in alphabetical order
|
|
returned_order = [r["room_id"] for r in rooms]
|
|
self.assertListEqual(expected_room_list, returned_order) # order is checked
|
|
|
|
# Create 3 test rooms
|
|
room_id_1 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
room_id_2 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
room_id_3 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
|
|
# Set room names in alphabetical order. room 1 -> A, 2 -> B, 3 -> C
|
|
self.helper.send_state(
|
|
room_id_1, "m.room.name", {"name": "A"}, tok=self.admin_user_tok,
|
|
)
|
|
self.helper.send_state(
|
|
room_id_2, "m.room.name", {"name": "B"}, tok=self.admin_user_tok,
|
|
)
|
|
self.helper.send_state(
|
|
room_id_3, "m.room.name", {"name": "C"}, tok=self.admin_user_tok,
|
|
)
|
|
|
|
# Set room canonical room aliases
|
|
_set_canonical_alias(room_id_1, "#A_alias:test", self.admin_user_tok)
|
|
_set_canonical_alias(room_id_2, "#B_alias:test", self.admin_user_tok)
|
|
_set_canonical_alias(room_id_3, "#C_alias:test", self.admin_user_tok)
|
|
|
|
# Set room member size in the reverse order. room 1 -> 1 member, 2 -> 2, 3 -> 3
|
|
user_1 = self.register_user("bob1", "pass")
|
|
user_1_tok = self.login("bob1", "pass")
|
|
self.helper.join(room_id_2, user_1, tok=user_1_tok)
|
|
|
|
user_2 = self.register_user("bob2", "pass")
|
|
user_2_tok = self.login("bob2", "pass")
|
|
self.helper.join(room_id_3, user_2, tok=user_2_tok)
|
|
|
|
user_3 = self.register_user("bob3", "pass")
|
|
user_3_tok = self.login("bob3", "pass")
|
|
self.helper.join(room_id_3, user_3, tok=user_3_tok)
|
|
|
|
# Test different sort orders, with forward and reverse directions
|
|
_order_test("name", [room_id_1, room_id_2, room_id_3])
|
|
_order_test("name", [room_id_3, room_id_2, room_id_1], reverse=True)
|
|
|
|
_order_test("canonical_alias", [room_id_1, room_id_2, room_id_3])
|
|
_order_test("canonical_alias", [room_id_3, room_id_2, room_id_1], reverse=True)
|
|
|
|
_order_test("joined_members", [room_id_3, room_id_2, room_id_1])
|
|
_order_test("joined_members", [room_id_1, room_id_2, room_id_3], reverse=True)
|
|
|
|
_order_test("joined_local_members", [room_id_3, room_id_2, room_id_1])
|
|
_order_test(
|
|
"joined_local_members", [room_id_1, room_id_2, room_id_3], reverse=True
|
|
)
|
|
|
|
_order_test("version", [room_id_1, room_id_2, room_id_3])
|
|
_order_test("version", [room_id_1, room_id_2, room_id_3], reverse=True)
|
|
|
|
_order_test("creator", [room_id_1, room_id_2, room_id_3])
|
|
_order_test("creator", [room_id_1, room_id_2, room_id_3], reverse=True)
|
|
|
|
_order_test("encryption", [room_id_1, room_id_2, room_id_3])
|
|
_order_test("encryption", [room_id_1, room_id_2, room_id_3], reverse=True)
|
|
|
|
_order_test("federatable", [room_id_1, room_id_2, room_id_3])
|
|
_order_test("federatable", [room_id_1, room_id_2, room_id_3], reverse=True)
|
|
|
|
_order_test("public", [room_id_1, room_id_2, room_id_3])
|
|
# Different sort order of SQlite and PostreSQL
|
|
# _order_test("public", [room_id_3, room_id_2, room_id_1], reverse=True)
|
|
|
|
_order_test("join_rules", [room_id_1, room_id_2, room_id_3])
|
|
_order_test("join_rules", [room_id_1, room_id_2, room_id_3], reverse=True)
|
|
|
|
_order_test("guest_access", [room_id_1, room_id_2, room_id_3])
|
|
_order_test("guest_access", [room_id_1, room_id_2, room_id_3], reverse=True)
|
|
|
|
_order_test("history_visibility", [room_id_1, room_id_2, room_id_3])
|
|
_order_test(
|
|
"history_visibility", [room_id_1, room_id_2, room_id_3], reverse=True
|
|
)
|
|
|
|
_order_test("state_events", [room_id_3, room_id_2, room_id_1])
|
|
_order_test("state_events", [room_id_1, room_id_2, room_id_3], reverse=True)
|
|
|
|
def test_search_term(self):
|
|
"""Test that searching for a room works correctly"""
|
|
# Create two test rooms
|
|
room_id_1 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
room_id_2 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
|
|
room_name_1 = "something"
|
|
room_name_2 = "else"
|
|
|
|
# Set the name for each room
|
|
self.helper.send_state(
|
|
room_id_1, "m.room.name", {"name": room_name_1}, tok=self.admin_user_tok,
|
|
)
|
|
self.helper.send_state(
|
|
room_id_2, "m.room.name", {"name": room_name_2}, tok=self.admin_user_tok,
|
|
)
|
|
|
|
def _search_test(
|
|
expected_room_id: Optional[str],
|
|
search_term: str,
|
|
expected_http_code: int = 200,
|
|
):
|
|
"""Search for a room and check that the returned room's id is a match
|
|
|
|
Args:
|
|
expected_room_id: The room_id expected to be returned by the API. Set
|
|
to None to expect zero results for the search
|
|
search_term: The term to search for room names with
|
|
expected_http_code: The expected http code for the request
|
|
"""
|
|
url = "/_synapse/admin/v1/rooms?search_term=%s" % (search_term,)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(expected_http_code, channel.code, msg=channel.json_body)
|
|
|
|
if expected_http_code != 200:
|
|
return
|
|
|
|
# Check that rooms were returned
|
|
self.assertTrue("rooms" in channel.json_body)
|
|
rooms = channel.json_body["rooms"]
|
|
|
|
# Check that the expected number of rooms were returned
|
|
expected_room_count = 1 if expected_room_id else 0
|
|
self.assertEqual(len(rooms), expected_room_count)
|
|
self.assertEqual(channel.json_body["total_rooms"], expected_room_count)
|
|
|
|
# Check that the offset is correct
|
|
# We're not paginating, so should be 0
|
|
self.assertEqual(channel.json_body["offset"], 0)
|
|
|
|
# Check that there is no `prev_batch`
|
|
self.assertNotIn("prev_batch", channel.json_body)
|
|
|
|
# Check that there is no `next_batch`
|
|
self.assertNotIn("next_batch", channel.json_body)
|
|
|
|
if expected_room_id:
|
|
# Check that the first returned room id is correct
|
|
r = rooms[0]
|
|
self.assertEqual(expected_room_id, r["room_id"])
|
|
|
|
# Perform search tests
|
|
_search_test(room_id_1, "something")
|
|
_search_test(room_id_1, "thing")
|
|
|
|
_search_test(room_id_2, "else")
|
|
_search_test(room_id_2, "se")
|
|
|
|
# Test case insensitive
|
|
_search_test(room_id_1, "SOMETHING")
|
|
_search_test(room_id_1, "THING")
|
|
|
|
_search_test(room_id_2, "ELSE")
|
|
_search_test(room_id_2, "SE")
|
|
|
|
_search_test(None, "foo")
|
|
_search_test(None, "bar")
|
|
_search_test(None, "", expected_http_code=400)
|
|
|
|
def test_single_room(self):
|
|
"""Test that a single room can be requested correctly"""
|
|
# Create two test rooms
|
|
room_id_1 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
room_id_2 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
|
|
room_name_1 = "something"
|
|
room_name_2 = "else"
|
|
|
|
# Set the name for each room
|
|
self.helper.send_state(
|
|
room_id_1, "m.room.name", {"name": room_name_1}, tok=self.admin_user_tok,
|
|
)
|
|
self.helper.send_state(
|
|
room_id_2, "m.room.name", {"name": room_name_2}, tok=self.admin_user_tok,
|
|
)
|
|
|
|
url = "/_synapse/admin/v1/rooms/%s" % (room_id_1,)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
|
|
self.assertIn("room_id", channel.json_body)
|
|
self.assertIn("name", channel.json_body)
|
|
self.assertIn("topic", channel.json_body)
|
|
self.assertIn("avatar", channel.json_body)
|
|
self.assertIn("canonical_alias", channel.json_body)
|
|
self.assertIn("joined_members", channel.json_body)
|
|
self.assertIn("joined_local_members", channel.json_body)
|
|
self.assertIn("joined_local_devices", channel.json_body)
|
|
self.assertIn("version", channel.json_body)
|
|
self.assertIn("creator", channel.json_body)
|
|
self.assertIn("encryption", channel.json_body)
|
|
self.assertIn("federatable", channel.json_body)
|
|
self.assertIn("public", channel.json_body)
|
|
self.assertIn("join_rules", channel.json_body)
|
|
self.assertIn("guest_access", channel.json_body)
|
|
self.assertIn("history_visibility", channel.json_body)
|
|
self.assertIn("state_events", channel.json_body)
|
|
|
|
self.assertEqual(room_id_1, channel.json_body["room_id"])
|
|
|
|
def test_single_room_devices(self):
|
|
"""Test that `joined_local_devices` can be requested correctly"""
|
|
room_id_1 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
|
|
url = "/_synapse/admin/v1/rooms/%s" % (room_id_1,)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(1, channel.json_body["joined_local_devices"])
|
|
|
|
# Have another user join the room
|
|
user_1 = self.register_user("foo", "pass")
|
|
user_tok_1 = self.login("foo", "pass")
|
|
self.helper.join(room_id_1, user_1, tok=user_tok_1)
|
|
|
|
url = "/_synapse/admin/v1/rooms/%s" % (room_id_1,)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(2, channel.json_body["joined_local_devices"])
|
|
|
|
# leave room
|
|
self.helper.leave(room_id_1, self.admin_user, tok=self.admin_user_tok)
|
|
self.helper.leave(room_id_1, user_1, tok=user_tok_1)
|
|
url = "/_synapse/admin/v1/rooms/%s" % (room_id_1,)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
self.assertEqual(0, channel.json_body["joined_local_devices"])
|
|
|
|
def test_room_members(self):
|
|
"""Test that room members can be requested correctly"""
|
|
# Create two test rooms
|
|
room_id_1 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
room_id_2 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
|
|
|
|
# Have another user join the room
|
|
user_1 = self.register_user("foo", "pass")
|
|
user_tok_1 = self.login("foo", "pass")
|
|
self.helper.join(room_id_1, user_1, tok=user_tok_1)
|
|
|
|
# Have another user join the room
|
|
user_2 = self.register_user("bar", "pass")
|
|
user_tok_2 = self.login("bar", "pass")
|
|
self.helper.join(room_id_1, user_2, tok=user_tok_2)
|
|
self.helper.join(room_id_2, user_2, tok=user_tok_2)
|
|
|
|
# Have another user join the room
|
|
user_3 = self.register_user("foobar", "pass")
|
|
user_tok_3 = self.login("foobar", "pass")
|
|
self.helper.join(room_id_2, user_3, tok=user_tok_3)
|
|
|
|
url = "/_synapse/admin/v1/rooms/%s/members" % (room_id_1,)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
|
|
self.assertCountEqual(
|
|
["@admin:test", "@foo:test", "@bar:test"], channel.json_body["members"]
|
|
)
|
|
self.assertEqual(channel.json_body["total"], 3)
|
|
|
|
url = "/_synapse/admin/v1/rooms/%s/members" % (room_id_2,)
|
|
channel = self.make_request(
|
|
"GET", url.encode("ascii"), access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, channel.code, msg=channel.json_body)
|
|
|
|
self.assertCountEqual(
|
|
["@admin:test", "@bar:test", "@foobar:test"], channel.json_body["members"]
|
|
)
|
|
self.assertEqual(channel.json_body["total"], 3)
|
|
|
|
|
|
class JoinAliasRoomTestCase(unittest.HomeserverTestCase):
|
|
|
|
servlets = [
|
|
synapse.rest.admin.register_servlets,
|
|
room.register_servlets,
|
|
login.register_servlets,
|
|
]
|
|
|
|
def prepare(self, reactor, clock, homeserver):
|
|
self.admin_user = self.register_user("admin", "pass", admin=True)
|
|
self.admin_user_tok = self.login("admin", "pass")
|
|
|
|
self.creator = self.register_user("creator", "test")
|
|
self.creator_tok = self.login("creator", "test")
|
|
|
|
self.second_user_id = self.register_user("second", "test")
|
|
self.second_tok = self.login("second", "test")
|
|
|
|
self.public_room_id = self.helper.create_room_as(
|
|
self.creator, tok=self.creator_tok, is_public=True
|
|
)
|
|
self.url = "/_synapse/admin/v1/join/{}".format(self.public_room_id)
|
|
|
|
def test_requester_is_no_admin(self):
|
|
"""
|
|
If the user is not a server admin, an error 403 is returned.
|
|
"""
|
|
body = json.dumps({"user_id": self.second_user_id})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.second_tok,
|
|
)
|
|
|
|
self.assertEqual(403, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
|
|
|
|
def test_invalid_parameter(self):
|
|
"""
|
|
If a parameter is missing, return an error
|
|
"""
|
|
body = json.dumps({"unknown_parameter": "@unknown:test"})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(Codes.MISSING_PARAM, channel.json_body["errcode"])
|
|
|
|
def test_local_user_does_not_exist(self):
|
|
"""
|
|
Tests that a lookup for a user that does not exist returns a 404
|
|
"""
|
|
body = json.dumps({"user_id": "@unknown:test"})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(404, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(Codes.NOT_FOUND, channel.json_body["errcode"])
|
|
|
|
def test_remote_user(self):
|
|
"""
|
|
Check that only local user can join rooms.
|
|
"""
|
|
body = json.dumps({"user_id": "@not:exist.bla"})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(
|
|
"This endpoint can only be used with local users",
|
|
channel.json_body["error"],
|
|
)
|
|
|
|
def test_room_does_not_exist(self):
|
|
"""
|
|
Check that unknown rooms/server return error 404.
|
|
"""
|
|
body = json.dumps({"user_id": self.second_user_id})
|
|
url = "/_synapse/admin/v1/join/!unknown:test"
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(404, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual("No known servers", channel.json_body["error"])
|
|
|
|
def test_room_is_not_valid(self):
|
|
"""
|
|
Check that invalid room names, return an error 400.
|
|
"""
|
|
body = json.dumps({"user_id": self.second_user_id})
|
|
url = "/_synapse/admin/v1/join/invalidroom"
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(
|
|
"invalidroom was not legal room ID or room alias",
|
|
channel.json_body["error"],
|
|
)
|
|
|
|
def test_join_public_room(self):
|
|
"""
|
|
Test joining a local user to a public room with "JoinRules.PUBLIC"
|
|
"""
|
|
body = json.dumps({"user_id": self.second_user_id})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
self.url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(self.public_room_id, channel.json_body["room_id"])
|
|
|
|
# Validate if user is a member of the room
|
|
|
|
channel = self.make_request(
|
|
"GET", "/_matrix/client/r0/joined_rooms", access_token=self.second_tok,
|
|
)
|
|
self.assertEquals(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(self.public_room_id, channel.json_body["joined_rooms"][0])
|
|
|
|
def test_join_private_room_if_not_member(self):
|
|
"""
|
|
Test joining a local user to a private room with "JoinRules.INVITE"
|
|
when server admin is not member of this room.
|
|
"""
|
|
private_room_id = self.helper.create_room_as(
|
|
self.creator, tok=self.creator_tok, is_public=False
|
|
)
|
|
url = "/_synapse/admin/v1/join/{}".format(private_room_id)
|
|
body = json.dumps({"user_id": self.second_user_id})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(403, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
|
|
|
|
def test_join_private_room_if_member(self):
|
|
"""
|
|
Test joining a local user to a private room with "JoinRules.INVITE",
|
|
when server admin is member of this room.
|
|
"""
|
|
private_room_id = self.helper.create_room_as(
|
|
self.creator, tok=self.creator_tok, is_public=False
|
|
)
|
|
self.helper.invite(
|
|
room=private_room_id,
|
|
src=self.creator,
|
|
targ=self.admin_user,
|
|
tok=self.creator_tok,
|
|
)
|
|
self.helper.join(
|
|
room=private_room_id, user=self.admin_user, tok=self.admin_user_tok
|
|
)
|
|
|
|
# Validate if server admin is a member of the room
|
|
|
|
channel = self.make_request(
|
|
"GET", "/_matrix/client/r0/joined_rooms", access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEquals(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(private_room_id, channel.json_body["joined_rooms"][0])
|
|
|
|
# Join user to room.
|
|
|
|
url = "/_synapse/admin/v1/join/{}".format(private_room_id)
|
|
body = json.dumps({"user_id": self.second_user_id})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(private_room_id, channel.json_body["room_id"])
|
|
|
|
# Validate if user is a member of the room
|
|
|
|
channel = self.make_request(
|
|
"GET", "/_matrix/client/r0/joined_rooms", access_token=self.second_tok,
|
|
)
|
|
self.assertEquals(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(private_room_id, channel.json_body["joined_rooms"][0])
|
|
|
|
def test_join_private_room_if_owner(self):
|
|
"""
|
|
Test joining a local user to a private room with "JoinRules.INVITE",
|
|
when server admin is owner of this room.
|
|
"""
|
|
private_room_id = self.helper.create_room_as(
|
|
self.admin_user, tok=self.admin_user_tok, is_public=False
|
|
)
|
|
url = "/_synapse/admin/v1/join/{}".format(private_room_id)
|
|
body = json.dumps({"user_id": self.second_user_id})
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
url,
|
|
content=body.encode(encoding="utf_8"),
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(private_room_id, channel.json_body["room_id"])
|
|
|
|
# Validate if user is a member of the room
|
|
|
|
channel = self.make_request(
|
|
"GET", "/_matrix/client/r0/joined_rooms", access_token=self.second_tok,
|
|
)
|
|
self.assertEquals(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(private_room_id, channel.json_body["joined_rooms"][0])
|
|
|
|
|
|
class MakeRoomAdminTestCase(unittest.HomeserverTestCase):
|
|
servlets = [
|
|
synapse.rest.admin.register_servlets,
|
|
room.register_servlets,
|
|
login.register_servlets,
|
|
]
|
|
|
|
def prepare(self, reactor, clock, homeserver):
|
|
self.admin_user = self.register_user("admin", "pass", admin=True)
|
|
self.admin_user_tok = self.login("admin", "pass")
|
|
|
|
self.creator = self.register_user("creator", "test")
|
|
self.creator_tok = self.login("creator", "test")
|
|
|
|
self.second_user_id = self.register_user("second", "test")
|
|
self.second_tok = self.login("second", "test")
|
|
|
|
self.public_room_id = self.helper.create_room_as(
|
|
self.creator, tok=self.creator_tok, is_public=True
|
|
)
|
|
self.url = "/_synapse/admin/v1/rooms/{}/make_room_admin".format(
|
|
self.public_room_id
|
|
)
|
|
|
|
def test_public_room(self):
|
|
"""Test that getting admin in a public room works.
|
|
"""
|
|
room_id = self.helper.create_room_as(
|
|
self.creator, tok=self.creator_tok, is_public=True
|
|
)
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
"/_synapse/admin/v1/rooms/{}/make_room_admin".format(room_id),
|
|
content={},
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Now we test that we can join the room and ban a user.
|
|
self.helper.join(room_id, self.admin_user, tok=self.admin_user_tok)
|
|
self.helper.change_membership(
|
|
room_id,
|
|
self.admin_user,
|
|
"@test:test",
|
|
Membership.BAN,
|
|
tok=self.admin_user_tok,
|
|
)
|
|
|
|
def test_private_room(self):
|
|
"""Test that getting admin in a private room works and we get invited.
|
|
"""
|
|
room_id = self.helper.create_room_as(
|
|
self.creator, tok=self.creator_tok, is_public=False,
|
|
)
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
"/_synapse/admin/v1/rooms/{}/make_room_admin".format(room_id),
|
|
content={},
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Now we test that we can join the room (we should have received an
|
|
# invite) and can ban a user.
|
|
self.helper.join(room_id, self.admin_user, tok=self.admin_user_tok)
|
|
self.helper.change_membership(
|
|
room_id,
|
|
self.admin_user,
|
|
"@test:test",
|
|
Membership.BAN,
|
|
tok=self.admin_user_tok,
|
|
)
|
|
|
|
def test_other_user(self):
|
|
"""Test that giving admin in a public room works to a non-admin user works.
|
|
"""
|
|
room_id = self.helper.create_room_as(
|
|
self.creator, tok=self.creator_tok, is_public=True
|
|
)
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
"/_synapse/admin/v1/rooms/{}/make_room_admin".format(room_id),
|
|
content={"user_id": self.second_user_id},
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"])
|
|
|
|
# Now we test that we can join the room and ban a user.
|
|
self.helper.join(room_id, self.second_user_id, tok=self.second_tok)
|
|
self.helper.change_membership(
|
|
room_id,
|
|
self.second_user_id,
|
|
"@test:test",
|
|
Membership.BAN,
|
|
tok=self.second_tok,
|
|
)
|
|
|
|
def test_not_enough_power(self):
|
|
"""Test that we get a sensible error if there are no local room admins.
|
|
"""
|
|
room_id = self.helper.create_room_as(
|
|
self.creator, tok=self.creator_tok, is_public=True
|
|
)
|
|
|
|
# The creator drops admin rights in the room.
|
|
pl = self.helper.get_state(
|
|
room_id, EventTypes.PowerLevels, tok=self.creator_tok
|
|
)
|
|
pl["users"][self.creator] = 0
|
|
self.helper.send_state(
|
|
room_id, EventTypes.PowerLevels, body=pl, tok=self.creator_tok
|
|
)
|
|
|
|
channel = self.make_request(
|
|
"POST",
|
|
"/_synapse/admin/v1/rooms/{}/make_room_admin".format(room_id),
|
|
content={},
|
|
access_token=self.admin_user_tok,
|
|
)
|
|
|
|
# We expect this to fail with a 400 as there are no room admins.
|
|
#
|
|
# (Note we assert the error message to ensure that it's not denied for
|
|
# some other reason)
|
|
self.assertEqual(400, int(channel.result["code"]), msg=channel.result["body"])
|
|
self.assertEqual(
|
|
channel.json_body["error"],
|
|
"No local admin user in room with power to update power levels.",
|
|
)
|
|
|
|
|
|
PURGE_TABLES = [
|
|
"current_state_events",
|
|
"event_backward_extremities",
|
|
"event_forward_extremities",
|
|
"event_json",
|
|
"event_push_actions",
|
|
"event_search",
|
|
"events",
|
|
"group_rooms",
|
|
"public_room_list_stream",
|
|
"receipts_graph",
|
|
"receipts_linearized",
|
|
"room_aliases",
|
|
"room_depth",
|
|
"room_memberships",
|
|
"room_stats_state",
|
|
"room_stats_current",
|
|
"room_stats_historical",
|
|
"room_stats_earliest_token",
|
|
"rooms",
|
|
"stream_ordering_to_exterm",
|
|
"users_in_public_rooms",
|
|
"users_who_share_private_rooms",
|
|
"appservice_room_list",
|
|
"e2e_room_keys",
|
|
"event_push_summary",
|
|
"pusher_throttle",
|
|
"group_summary_rooms",
|
|
"room_account_data",
|
|
"room_tags",
|
|
# "state_groups", # Current impl leaves orphaned state groups around.
|
|
"state_groups_state",
|
|
]
|