synapse-product/tests/rest/client/v1/test_rooms.py

1001 lines
37 KiB
Python
Raw Normal View History

2014-08-12 10:10:52 -04:00
# -*- coding: utf-8 -*-
2016-01-06 23:26:29 -05:00
# Copyright 2014-2016 OpenMarket Ltd
2019-05-16 10:10:24 -04:00
# Copyright 2019 The Matrix.org Foundation C.I.C.
#
# 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.
2014-08-12 10:10:52 -04:00
"""Tests REST events for /rooms paths."""
2018-07-09 02:09:20 -04:00
import json
from mock import Mock, NonCallableMock
from six.moves.urllib import parse as urlparse
2014-08-12 10:10:52 -04:00
from twisted.internet import defer
import synapse.rest.admin
2014-08-12 10:10:52 -04:00
from synapse.api.constants import Membership
2019-05-16 10:09:16 -04:00
from synapse.rest.client.v1 import login, profile, room
2014-08-12 10:10:52 -04:00
from tests import unittest
2014-08-12 10:10:52 -04:00
PATH_PREFIX = b"/_matrix/client/api/v1"
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
class RoomBase(unittest.HomeserverTestCase):
rmcreator_id = None
2018-09-06 12:58:18 -04:00
servlets = [room.register_servlets, room.register_deprecated_servlets]
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
def make_homeserver(self, reactor, clock):
2018-09-06 12:58:18 -04:00
self.hs = self.setup_test_homeserver(
"red",
2014-08-12 10:10:52 -04:00
http_client=None,
federation_client=Mock(),
ratelimiter=NonCallableMock(spec_set=["can_do_action"]),
2014-08-12 10:10:52 -04:00
)
self.ratelimiter = self.hs.get_ratelimiter()
self.ratelimiter.can_do_action.return_value = (True, 0)
2014-09-03 04:15:22 -04:00
self.hs.get_federation_handler = Mock(return_value=Mock())
2014-08-12 10:10:52 -04:00
2014-11-11 03:09:42 -05:00
def _insert_client_ip(*args, **kwargs):
return defer.succeed(None)
self.hs.get_datastore().insert_client_ip = _insert_client_ip
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
return self.hs
2014-08-12 10:10:52 -04:00
class RoomPermissionsTestCase(RoomBase):
""" Tests room permissions. """
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
user_id = "@sid1:red"
rmcreator_id = "@notme:red"
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
def prepare(self, reactor, clock, hs):
self.helper.auth_user_id = self.rmcreator_id
# create some rooms under the name rmcreator_id
self.uncreated_rmid = "!aa:test"
self.created_rmid = self.helper.create_room_as(
self.rmcreator_id, is_public=False
)
self.created_public_rmid = self.helper.create_room_as(
self.rmcreator_id, is_public=True
)
2014-08-12 10:10:52 -04:00
# send a message in one of the rooms
2016-02-19 10:34:38 -05:00
self.created_rmid_msg_path = (
"rooms/%s/send/m.room.message/a1" % (self.created_rmid)
2019-06-20 05:32:02 -04:00
).encode("ascii")
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"PUT", self.created_rmid_msg_path, b'{"msgtype":"m.text","body":"test msg"}'
2016-02-19 10:34:38 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(200, channel.code, channel.result)
2014-08-12 10:10:52 -04:00
# set topic for public room
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"PUT",
2019-06-20 05:32:02 -04:00
("rooms/%s/state/m.room.topic" % self.created_public_rmid).encode("ascii"),
b'{"topic":"Public Room Topic"}',
2016-02-19 10:34:38 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(200, channel.code, channel.result)
2014-08-12 10:10:52 -04:00
# auth as user_id now
self.helper.auth_user_id = self.user_id
2014-08-12 10:10:52 -04:00
def test_can_do_action(self):
msg_content = b'{"msgtype":"m.text","body":"hello"}'
seq = iter(range(100))
def send_msg_path():
2018-09-06 12:58:18 -04:00
return "/rooms/%s/send/m.room.message/mid%s" % (
self.created_rmid,
2018-09-06 12:58:18 -04:00
str(next(seq)),
)
2014-08-12 10:10:52 -04:00
# send message in uncreated room, expect 403
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"PUT",
"/rooms/%s/send/m.room.message/mid2" % (self.uncreated_rmid,),
msg_content,
2014-11-11 03:09:42 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# send message in created room not joined (no state), expect 403
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", send_msg_path(), msg_content)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# send message in created room and invited, expect 403
self.helper.invite(
room=self.created_rmid, src=self.rmcreator_id, targ=self.user_id
2014-11-11 03:09:42 -05:00
)
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", send_msg_path(), msg_content)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# send message in created room and joined, expect 200
self.helper.join(room=self.created_rmid, user=self.user_id)
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", send_msg_path(), msg_content)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# send message in created room and left, expect 403
self.helper.leave(room=self.created_rmid, user=self.user_id)
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", send_msg_path(), msg_content)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
def test_topic_perms(self):
topic_content = b'{"topic":"My Topic Name"}'
2018-09-06 12:58:18 -04:00
topic_path = "/rooms/%s/state/m.room.topic" % self.created_rmid
2014-08-12 10:10:52 -04:00
# set/get topic in uncreated room, expect 403
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"PUT", "/rooms/%s/state/m.room.topic" % self.uncreated_rmid, topic_content
2016-02-19 10:34:38 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
request, channel = self.make_request(
"GET", "/rooms/%s/state/m.room.topic" % self.uncreated_rmid
2016-02-19 10:34:38 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# set/get topic in created PRIVATE room not joined, expect 403
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", topic_path, topic_content)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
request, channel = self.make_request("GET", topic_path)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# set topic in created PRIVATE room and invited, expect 403
self.helper.invite(
2016-02-19 10:34:38 -05:00
room=self.created_rmid, src=self.rmcreator_id, targ=self.user_id
)
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", topic_path, topic_content)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# get topic in created PRIVATE room and invited, expect 403
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", topic_path)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# set/get topic in created PRIVATE room and joined, expect 200
self.helper.join(room=self.created_rmid, user=self.user_id)
2014-11-11 03:09:42 -05:00
# Only room ops can set topic by default
self.helper.auth_user_id = self.rmcreator_id
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", topic_path, topic_content)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
self.helper.auth_user_id = self.user_id
2014-11-11 03:09:42 -05:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", topic_path)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2019-06-20 05:32:02 -04:00
self.assert_dict(json.loads(topic_content.decode("utf8")), channel.json_body)
2014-08-12 10:10:52 -04:00
# set/get topic in created PRIVATE room and left, expect 403
self.helper.leave(room=self.created_rmid, user=self.user_id)
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", topic_path, topic_content)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
request, channel = self.make_request("GET", topic_path)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# get topic in PUBLIC room, not joined, expect 403
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"GET", "/rooms/%s/state/m.room.topic" % self.created_public_rmid
2016-02-19 10:34:38 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# set topic in PUBLIC room, not joined, expect 403
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"PUT",
"/rooms/%s/state/m.room.topic" % self.created_public_rmid,
topic_content,
2016-02-19 10:34:38 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
def _test_get_membership(self, room=None, members=[], expect_code=None):
for member in members:
2018-09-06 12:58:18 -04:00
path = "/rooms/%s/state/m.room.member/%s" % (room, member)
request, channel = self.make_request("GET", path)
self.render(request)
self.assertEquals(expect_code, channel.code)
2014-08-12 10:10:52 -04:00
def test_membership_basic_room_perms(self):
# === room does not exist ===
room = self.uncreated_rmid
# get membership of self, get membership of other, uncreated room
# expect all 403s
self._test_get_membership(
members=[self.user_id, self.rmcreator_id], room=room, expect_code=403
)
2014-08-12 10:10:52 -04:00
# trying to invite people to this room should 403
self.helper.invite(
room=room, src=self.user_id, targ=self.rmcreator_id, expect_code=403
)
2014-08-12 10:10:52 -04:00
# set [invite/join/left] of self, set [invite/join/left] of other,
# expect all 404s because room doesn't exist on any server
2014-08-12 10:10:52 -04:00
for usr in [self.user_id, self.rmcreator_id]:
self.helper.join(room=room, user=usr, expect_code=404)
self.helper.leave(room=room, user=usr, expect_code=404)
2014-08-12 10:10:52 -04:00
def test_membership_private_room_perms(self):
room = self.created_rmid
# get membership of self, get membership of other, private room + invite
# expect all 403s
self.helper.invite(room=room, src=self.rmcreator_id, targ=self.user_id)
self._test_get_membership(
members=[self.user_id, self.rmcreator_id], room=room, expect_code=403
)
2014-08-12 10:10:52 -04:00
# get membership of self, get membership of other, private room + joined
# expect all 200s
self.helper.join(room=room, user=self.user_id)
self._test_get_membership(
members=[self.user_id, self.rmcreator_id], room=room, expect_code=200
)
2014-08-12 10:10:52 -04:00
# get membership of self, get membership of other, private room + left
# expect all 200s
self.helper.leave(room=room, user=self.user_id)
self._test_get_membership(
members=[self.user_id, self.rmcreator_id], room=room, expect_code=200
)
2014-08-12 10:10:52 -04:00
def test_membership_public_room_perms(self):
room = self.created_public_rmid
# get membership of self, get membership of other, public room + invite
# expect 403
self.helper.invite(room=room, src=self.rmcreator_id, targ=self.user_id)
self._test_get_membership(
members=[self.user_id, self.rmcreator_id], room=room, expect_code=403
)
2014-08-12 10:10:52 -04:00
# get membership of self, get membership of other, public room + joined
# expect all 200s
self.helper.join(room=room, user=self.user_id)
self._test_get_membership(
members=[self.user_id, self.rmcreator_id], room=room, expect_code=200
)
2014-08-12 10:10:52 -04:00
# get membership of self, get membership of other, public room + left
# expect 200.
self.helper.leave(room=room, user=self.user_id)
self._test_get_membership(
members=[self.user_id, self.rmcreator_id], room=room, expect_code=200
)
2014-08-12 10:10:52 -04:00
def test_invited_permissions(self):
room = self.created_rmid
self.helper.invite(room=room, src=self.rmcreator_id, targ=self.user_id)
2014-08-12 10:10:52 -04:00
# set [invite/join/left] of other user, expect 403s
self.helper.invite(
room=room, src=self.user_id, targ=self.rmcreator_id, expect_code=403
)
self.helper.change_membership(
room=room,
src=self.user_id,
targ=self.rmcreator_id,
membership=Membership.JOIN,
expect_code=403,
)
self.helper.change_membership(
room=room,
src=self.user_id,
targ=self.rmcreator_id,
membership=Membership.LEAVE,
expect_code=403,
)
2014-08-12 10:10:52 -04:00
def test_joined_permissions(self):
room = self.created_rmid
self.helper.invite(room=room, src=self.rmcreator_id, targ=self.user_id)
self.helper.join(room=room, user=self.user_id)
2014-08-12 10:10:52 -04:00
# set invited of self, expect 403
self.helper.invite(
room=room, src=self.user_id, targ=self.user_id, expect_code=403
)
2014-08-12 10:10:52 -04:00
# set joined of self, expect 200 (NOOP)
self.helper.join(room=room, user=self.user_id)
2014-08-12 10:10:52 -04:00
other = "@burgundy:red"
# set invited of other, expect 200
self.helper.invite(room=room, src=self.user_id, targ=other, expect_code=200)
2014-08-12 10:10:52 -04:00
# set joined of other, expect 403
self.helper.change_membership(
room=room,
src=self.user_id,
targ=other,
membership=Membership.JOIN,
expect_code=403,
)
2014-08-12 10:10:52 -04:00
# set left of other, expect 403
self.helper.change_membership(
room=room,
src=self.user_id,
targ=other,
membership=Membership.LEAVE,
expect_code=403,
)
2014-08-12 10:10:52 -04:00
# set left of self, expect 200
self.helper.leave(room=room, user=self.user_id)
2014-08-12 10:10:52 -04:00
def test_leave_permissions(self):
room = self.created_rmid
self.helper.invite(room=room, src=self.rmcreator_id, targ=self.user_id)
self.helper.join(room=room, user=self.user_id)
self.helper.leave(room=room, user=self.user_id)
2014-08-12 10:10:52 -04:00
# set [invite/join/left] of self, set [invite/join/left] of other,
# expect all 403s
for usr in [self.user_id, self.rmcreator_id]:
self.helper.change_membership(
2014-11-11 03:09:42 -05:00
room=room,
src=self.user_id,
targ=usr,
membership=Membership.INVITE,
expect_code=403,
2014-11-11 03:09:42 -05:00
)
self.helper.change_membership(
2014-11-11 03:09:42 -05:00
room=room,
src=self.user_id,
targ=usr,
membership=Membership.JOIN,
expect_code=403,
2014-11-11 03:09:42 -05:00
)
# It is always valid to LEAVE if you've already left (currently.)
self.helper.change_membership(
2014-11-11 03:09:42 -05:00
room=room,
src=self.user_id,
targ=self.rmcreator_id,
membership=Membership.LEAVE,
expect_code=403,
2014-11-11 03:09:42 -05:00
)
2014-08-12 10:10:52 -04:00
class RoomsMemberListTestCase(RoomBase):
2014-08-12 10:10:52 -04:00
""" Tests /rooms/$room_id/members/list REST events."""
2014-11-11 03:09:42 -05:00
2018-09-06 12:58:18 -04:00
user_id = "@sid1:red"
2014-08-12 10:10:52 -04:00
def test_get_member_list(self):
room_id = self.helper.create_room_as(self.user_id)
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", "/rooms/%s/members" % room_id)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
def test_get_member_list_no_room(self):
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", "/rooms/roomdoesnotexist/members")
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
def test_get_member_list_no_permission(self):
2018-09-06 12:58:18 -04:00
room_id = self.helper.create_room_as("@some_other_guy:red")
request, channel = self.make_request("GET", "/rooms/%s/members" % room_id)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
def test_get_member_list_mixed_memberships(self):
2018-09-06 12:58:18 -04:00
room_creator = "@some_other_guy:red"
room_id = self.helper.create_room_as(room_creator)
2018-09-06 12:58:18 -04:00
room_path = "/rooms/%s/members" % room_id
self.helper.invite(room=room_id, src=room_creator, targ=self.user_id)
2014-08-12 10:10:52 -04:00
# can't see list if you're just invited.
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", room_path)
self.render(request)
self.assertEquals(403, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
self.helper.join(room=room_id, user=self.user_id)
2014-08-12 10:10:52 -04:00
# can see list now joined
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", room_path)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
self.helper.leave(room=room_id, user=self.user_id)
# can see old list once left
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", room_path)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
class RoomsCreateTestCase(RoomBase):
2014-08-12 10:10:52 -04:00
""" Tests /rooms and /rooms/$room_id REST events. """
2018-09-06 12:58:18 -04:00
user_id = "@sid1:red"
2014-08-12 10:10:52 -04:00
def test_post_room_no_keys(self):
# POST with no config keys, expect new room id
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("POST", "/createRoom", "{}")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(200, channel.code, channel.result)
self.assertTrue("room_id" in channel.json_body)
2014-08-12 10:10:52 -04:00
def test_post_room_visibility_key(self):
# POST with visibility config key, expect new room id
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"POST", "/createRoom", b'{"visibility":"private"}'
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(200, channel.code)
self.assertTrue("room_id" in channel.json_body)
2014-08-12 10:10:52 -04:00
def test_post_room_custom_key(self):
# POST with custom config keys, expect new room id
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"POST", "/createRoom", b'{"custom":"stuff"}'
)
self.render(request)
self.assertEquals(200, channel.code)
self.assertTrue("room_id" in channel.json_body)
2014-08-12 10:10:52 -04:00
def test_post_room_known_and_unknown_keys(self):
# POST with custom + known config keys, expect new room id
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"POST", "/createRoom", b'{"visibility":"private","custom":"things"}'
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(200, channel.code)
self.assertTrue("room_id" in channel.json_body)
2014-08-12 10:10:52 -04:00
def test_post_room_invalid_content(self):
# POST with invalid content / paths, expect 400
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("POST", "/createRoom", b'{"visibili')
self.render(request)
self.assertEquals(400, channel.code)
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("POST", "/createRoom", b'["hello"]')
self.render(request)
self.assertEquals(400, channel.code)
2014-08-12 10:10:52 -04:00
class RoomTopicTestCase(RoomBase):
2014-08-12 10:10:52 -04:00
""" Tests /rooms/$room_id/topic REST events. """
2018-09-06 12:58:18 -04:00
user_id = "@sid1:red"
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
def prepare(self, reactor, clock, hs):
2014-08-12 10:10:52 -04:00
# create the room
self.room_id = self.helper.create_room_as(self.user_id)
2018-09-06 12:58:18 -04:00
self.path = "/rooms/%s/state/m.room.topic" % (self.room_id,)
2014-08-12 10:10:52 -04:00
def test_invalid_puts(self):
# missing keys or invalid json
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", self.path, "{}")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", self.path, '{"_name":"bo"}')
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", self.path, '{"nao')
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"PUT", self.path, '[{"_name":"bo"},{"_name":"jill"}]'
2016-02-19 10:34:38 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", self.path, "text only")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", self.path, "")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# valid key, wrong type
content = '{"topic":["Topic name"]}'
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", self.path, content)
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
def test_rooms_topic(self):
# nothing should be there
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", self.path)
self.render(request)
self.assertEquals(404, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# valid put
content = '{"topic":"Topic name"}'
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", self.path, content)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# valid get
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", self.path)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
self.assert_dict(json.loads(content), channel.json_body)
2014-08-12 10:10:52 -04:00
def test_rooms_topic_with_extra_keys(self):
# valid put with extra keys
content = '{"topic":"Seasons","subtopic":"Summer"}'
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", self.path, content)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# valid get
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", self.path)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
self.assert_dict(json.loads(content), channel.json_body)
2014-08-12 10:10:52 -04:00
class RoomMemberStateTestCase(RoomBase):
2014-08-12 10:10:52 -04:00
""" Tests /rooms/$room_id/members/$user_id/state REST events. """
2014-09-03 04:15:22 -04:00
2018-09-06 12:58:18 -04:00
user_id = "@sid1:red"
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
def prepare(self, reactor, clock, hs):
self.room_id = self.helper.create_room_as(self.user_id)
2014-08-12 10:10:52 -04:00
def test_invalid_puts(self):
2014-08-26 10:54:25 -04:00
path = "/rooms/%s/state/m.room.member/%s" % (self.room_id, self.user_id)
2014-08-12 10:10:52 -04:00
# missing keys or invalid json
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", path, "{}")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", path, '{"_name":"bo"}')
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", path, '{"nao')
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"PUT", path, b'[{"_name":"bo"},{"_name":"jill"}]'
2016-02-19 10:34:38 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", path, "text only")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", path, "")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# valid keys, wrong types
content = '{"membership":["%s","%s","%s"]}' % (
Membership.INVITE,
Membership.JOIN,
Membership.LEAVE,
)
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", path, content.encode("ascii"))
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
def test_rooms_members_self(self):
2014-08-26 10:54:25 -04:00
path = "/rooms/%s/state/m.room.member/%s" % (
urlparse.quote(self.room_id),
self.user_id,
2014-08-12 10:10:52 -04:00
)
# valid join message (NOOP since we made the room)
content = '{"membership":"%s"}' % Membership.JOIN
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", path, content.encode("ascii"))
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", path, None)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
expected_response = {"membership": Membership.JOIN}
self.assertEquals(expected_response, channel.json_body)
2014-08-12 10:10:52 -04:00
def test_rooms_members_other(self):
self.other_id = "@zzsid1:red"
2014-08-26 10:54:25 -04:00
path = "/rooms/%s/state/m.room.member/%s" % (
urlparse.quote(self.room_id),
self.other_id,
2014-08-12 10:10:52 -04:00
)
# valid invite message
content = '{"membership":"%s"}' % Membership.INVITE
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", path, content)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", path, None)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
self.assertEquals(json.loads(content), channel.json_body)
2014-08-12 10:10:52 -04:00
def test_rooms_members_other_custom_keys(self):
self.other_id = "@zzsid1:red"
2014-08-26 10:54:25 -04:00
path = "/rooms/%s/state/m.room.member/%s" % (
urlparse.quote(self.room_id),
self.other_id,
2014-08-12 10:10:52 -04:00
)
# valid invite message with custom key
content = '{"membership":"%s","invite_text":"%s"}' % (
Membership.INVITE,
"Join us!",
)
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", path, content)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("GET", path, None)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
self.assertEquals(json.loads(content), channel.json_body)
2014-08-12 10:10:52 -04:00
class RoomMessagesTestCase(RoomBase):
2014-08-12 10:10:52 -04:00
""" Tests /rooms/$room_id/messages/$user_id/$msg_id REST events. """
2014-08-12 10:10:52 -04:00
user_id = "@sid1:red"
2018-09-06 12:58:18 -04:00
def prepare(self, reactor, clock, hs):
self.room_id = self.helper.create_room_as(self.user_id)
2014-11-11 03:09:42 -05:00
2014-08-12 10:10:52 -04:00
def test_invalid_puts(self):
path = "/rooms/%s/send/m.room.message/mid1" % (urlparse.quote(self.room_id))
2014-08-12 10:10:52 -04:00
# missing keys or invalid json
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", path, b"{}")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", path, b'{"_name":"bo"}')
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request("PUT", path, b'{"nao')
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"PUT", path, b'[{"_name":"bo"},{"_name":"jill"}]'
2016-02-19 10:34:38 -05:00
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", path, b"text only")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
2019-06-20 05:32:02 -04:00
request, channel = self.make_request("PUT", path, b"")
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
def test_rooms_messages_sent(self):
path = "/rooms/%s/send/m.room.message/mid1" % (urlparse.quote(self.room_id))
2014-08-12 10:10:52 -04:00
2018-09-06 12:58:18 -04:00
content = b'{"body":"test","msgtype":{"type":"a"}}'
request, channel = self.make_request("PUT", path, content)
self.render(request)
self.assertEquals(400, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# custom message types
2018-09-06 12:58:18 -04:00
content = b'{"body":"test","msgtype":"test.custom.text"}'
request, channel = self.make_request("PUT", path, content)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
# m.text message type
path = "/rooms/%s/send/m.room.message/mid2" % (urlparse.quote(self.room_id))
2018-09-06 12:58:18 -04:00
content = b'{"body":"test2","msgtype":"m.text"}'
request, channel = self.make_request("PUT", path, content)
self.render(request)
self.assertEquals(200, channel.code, msg=channel.result["body"])
2014-08-12 10:10:52 -04:00
class RoomInitialSyncTestCase(RoomBase):
""" Tests /rooms/$room_id/initialSync. """
user_id = "@sid1:red"
2018-09-06 12:58:18 -04:00
def prepare(self, reactor, clock, hs):
# create the room
self.room_id = self.helper.create_room_as(self.user_id)
def test_initial_sync(self):
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"GET", "/rooms/%s/initialSync" % self.room_id
)
self.render(request)
self.assertEquals(200, channel.code)
self.assertEquals(self.room_id, channel.json_body["room_id"])
self.assertEquals("join", channel.json_body["membership"])
# Room state is easier to assert on if we unpack it into a dict
state = {}
for event in channel.json_body["state"]:
if "state_key" not in event:
continue
t = event["type"]
if t not in state:
state[t] = []
state[t].append(event)
self.assertTrue("m.room.create" in state)
self.assertTrue("messages" in channel.json_body)
self.assertTrue("chunk" in channel.json_body["messages"])
self.assertTrue("end" in channel.json_body["messages"])
self.assertTrue("presence" in channel.json_body)
2016-02-19 10:34:38 -05:00
presence_by_user = {
e["content"]["user_id"]: e for e in channel.json_body["presence"]
}
self.assertTrue(self.user_id in presence_by_user)
self.assertEquals("m.presence", presence_by_user[self.user_id]["type"])
class RoomMessageListTestCase(RoomBase):
""" Tests /rooms/$room_id/messages REST events. """
user_id = "@sid1:red"
2018-09-06 12:58:18 -04:00
def prepare(self, reactor, clock, hs):
self.room_id = self.helper.create_room_as(self.user_id)
def test_topo_token_is_accepted(self):
2017-07-10 09:53:19 -04:00
token = "t1-0_0_0_0_0_0_0_0_0"
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"GET", "/rooms/%s/messages?access_token=x&from=%s" % (self.room_id, token)
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(200, channel.code)
self.assertTrue("start" in channel.json_body)
2019-06-20 05:32:02 -04:00
self.assertEquals(token, channel.json_body["start"])
self.assertTrue("chunk" in channel.json_body)
self.assertTrue("end" in channel.json_body)
def test_stream_token_is_accepted_for_fwd_pagianation(self):
2017-07-10 09:53:19 -04:00
token = "s0_0_0_0_0_0_0_0_0"
2018-09-06 12:58:18 -04:00
request, channel = self.make_request(
"GET", "/rooms/%s/messages?access_token=x&from=%s" % (self.room_id, token)
)
2018-09-06 12:58:18 -04:00
self.render(request)
self.assertEquals(200, channel.code)
self.assertTrue("start" in channel.json_body)
2019-06-20 05:32:02 -04:00
self.assertEquals(token, channel.json_body["start"])
self.assertTrue("chunk" in channel.json_body)
self.assertTrue("end" in channel.json_body)
2018-10-30 13:33:41 -04:00
class RoomSearchTestCase(unittest.HomeserverTestCase):
servlets = [
synapse.rest.admin.register_servlets_for_client_rest_resource,
2018-10-30 13:33:41 -04:00
room.register_servlets,
login.register_servlets,
]
user_id = True
hijack_auth = False
def prepare(self, reactor, clock, hs):
# Register the user who does the searching
self.user_id = self.register_user("user", "pass")
self.access_token = self.login("user", "pass")
# Register the user who sends the message
self.other_user_id = self.register_user("otheruser", "pass")
self.other_access_token = self.login("otheruser", "pass")
# Create a room
self.room = self.helper.create_room_as(self.user_id, tok=self.access_token)
# Invite the other person
self.helper.invite(
room=self.room,
src=self.user_id,
tok=self.access_token,
targ=self.other_user_id,
)
# The other user joins
self.helper.join(
room=self.room, user=self.other_user_id, tok=self.other_access_token
)
def test_finds_message(self):
"""
The search functionality will search for content in messages if asked to
do so.
"""
# The other user sends some messages
self.helper.send(self.room, body="Hi!", tok=self.other_access_token)
self.helper.send(self.room, body="There!", tok=self.other_access_token)
request, channel = self.make_request(
"POST",
"/search?access_token=%s" % (self.access_token,),
{
"search_categories": {
"room_events": {"keys": ["content.body"], "search_term": "Hi"}
}
},
)
self.render(request)
# Check we get the results we expect -- one search result, of the sent
# messages
self.assertEqual(channel.code, 200)
results = channel.json_body["search_categories"]["room_events"]
self.assertEqual(results["count"], 1)
self.assertEqual(results["results"][0]["result"]["content"]["body"], "Hi!")
# No context was requested, so we should get none.
self.assertEqual(results["results"][0]["context"], {})
def test_include_context(self):
"""
When event_context includes include_profile, profile information will be
included in the search response.
"""
# The other user sends some messages
self.helper.send(self.room, body="Hi!", tok=self.other_access_token)
self.helper.send(self.room, body="There!", tok=self.other_access_token)
request, channel = self.make_request(
"POST",
"/search?access_token=%s" % (self.access_token,),
{
"search_categories": {
"room_events": {
"keys": ["content.body"],
"search_term": "Hi",
"event_context": {"include_profile": True},
}
}
},
)
self.render(request)
# Check we get the results we expect -- one search result, of the sent
# messages
self.assertEqual(channel.code, 200)
results = channel.json_body["search_categories"]["room_events"]
self.assertEqual(results["count"], 1)
self.assertEqual(results["results"][0]["result"]["content"]["body"], "Hi!")
# We should get context info, like the two users, and the display names.
context = results["results"][0]["context"]
self.assertEqual(len(context["profile_info"].keys()), 2)
self.assertEqual(
context["profile_info"][self.other_user_id]["displayname"], "otheruser"
)
class PublicRoomsRestrictedTestCase(unittest.HomeserverTestCase):
servlets = [
2019-05-08 16:57:03 -04:00
synapse.rest.admin.register_servlets_for_client_rest_resource,
room.register_servlets,
login.register_servlets,
]
def make_homeserver(self, reactor, clock):
self.url = b"/_matrix/client/r0/publicRooms"
config = self.default_config()
config["allow_public_rooms_without_auth"] = False
self.hs = self.setup_test_homeserver(config=config)
return self.hs
def test_restricted_no_auth(self):
request, channel = self.make_request("GET", self.url)
self.render(request)
self.assertEqual(channel.code, 401, channel.result)
def test_restricted_auth(self):
self.register_user("user", "pass")
tok = self.login("user", "pass")
request, channel = self.make_request("GET", self.url, access_token=tok)
self.render(request)
self.assertEqual(channel.code, 200, channel.result)
2019-05-16 10:09:16 -04:00
class PerRoomProfilesForbiddenTestCase(unittest.HomeserverTestCase):
servlets = [
synapse.rest.admin.register_servlets_for_client_rest_resource,
room.register_servlets,
login.register_servlets,
profile.register_servlets,
]
def make_homeserver(self, reactor, clock):
config = self.default_config()
config["allow_per_room_profiles"] = False
self.hs = self.setup_test_homeserver(config=config)
return self.hs
def prepare(self, reactor, clock, homeserver):
self.user_id = self.register_user("test", "test")
self.tok = self.login("test", "test")
# Set a profile for the test user
self.displayname = "test user"
2019-06-20 05:32:02 -04:00
data = {"displayname": self.displayname}
2019-05-16 10:09:16 -04:00
request_data = json.dumps(data)
request, channel = self.make_request(
"PUT",
"/_matrix/client/r0/profile/%s/displayname" % (self.user_id,),
request_data,
access_token=self.tok,
)
self.render(request)
self.assertEqual(channel.code, 200, channel.result)
self.room_id = self.helper.create_room_as(self.user_id, tok=self.tok)
def test_per_room_profile_forbidden(self):
2019-06-20 05:32:02 -04:00
data = {"membership": "join", "displayname": "other test user"}
2019-05-16 10:09:16 -04:00
request_data = json.dumps(data)
request, channel = self.make_request(
"PUT",
2019-06-20 05:32:02 -04:00
"/_matrix/client/r0/rooms/%s/state/m.room.member/%s"
% (self.room_id, self.user_id),
2019-05-16 10:09:16 -04:00
request_data,
access_token=self.tok,
)
self.render(request)
self.assertEqual(channel.code, 200, channel.result)
event_id = channel.json_body["event_id"]
request, channel = self.make_request(
"GET",
"/_matrix/client/r0/rooms/%s/event/%s" % (self.room_id, event_id),
access_token=self.tok,
)
self.render(request)
self.assertEqual(channel.code, 200, channel.result)
res_displayname = channel.json_body["content"]["displayname"]
self.assertEqual(res_displayname, self.displayname, channel.result)