diff --git a/tests/rest/__init__.py b/tests/rest/__init__.py
deleted file mode 100644
index 9bff9ec169..0000000000
--- a/tests/rest/__init__.py
+++ /dev/null
@@ -1,15 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2014 OpenMarket Ltd
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
diff --git a/tests/rest/test_events.py b/tests/rest/test_events.py
deleted file mode 100644
index d3159e2cf4..0000000000
--- a/tests/rest/test_events.py
+++ /dev/null
@@ -1,225 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2014 OpenMarket Ltd
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-""" Tests REST events for /events paths."""
-from tests import unittest
-
-# twisted imports
-from twisted.internet import defer
-
-import synapse.rest.events
-import synapse.rest.register
-import synapse.rest.room
-
-from synapse.server import HomeServer
-
-from ..utils import MockHttpResource, SQLiteMemoryDbPool, MockKey
-from .utils import RestTestCase
-
-from mock import Mock, NonCallableMock
-
-
-PATH_PREFIX = "/_matrix/client/api/v1"
-
-
-class EventStreamPaginationApiTestCase(unittest.TestCase):
- """ Tests event streaming query parameters and start/end keys used in the
- Pagination stream API. """
- user_id = "sid1"
-
- def setUp(self):
- # configure stream and inject items
- pass
-
- def tearDown(self):
- pass
-
- def TODO_test_long_poll(self):
- # stream from 'end' key, send (self+other) message, expect message.
-
- # stream from 'END', send (self+other) message, expect message.
-
- # stream from 'end' key, send (self+other) topic, expect topic.
-
- # stream from 'END', send (self+other) topic, expect topic.
-
- # stream from 'end' key, send (self+other) invite, expect invite.
-
- # stream from 'END', send (self+other) invite, expect invite.
-
- pass
-
- def TODO_test_stream_forward(self):
- # stream from START, expect injected items
-
- # stream from 'start' key, expect same content
-
- # stream from 'end' key, expect nothing
-
- # stream from 'END', expect nothing
-
- # The following is needed for cases where content is removed e.g. you
- # left a room, so the token you're streaming from is > the one that
- # would be returned naturally from START>END.
- # stream from very new token (higher than end key), expect same token
- # returned as end key
- pass
-
- def TODO_test_limits(self):
- # stream from a key, expect limit_num items
-
- # stream from START, expect limit_num items
-
- pass
-
- def TODO_test_range(self):
- # stream from key to key, expect X items
-
- # stream from key to END, expect X items
-
- # stream from START to key, expect X items
-
- # stream from START to END, expect all items
- pass
-
- def TODO_test_direction(self):
- # stream from END to START and fwds, expect newest first
-
- # stream from END to START and bwds, expect oldest first
-
- # stream from START to END and fwds, expect oldest first
-
- # stream from START to END and bwds, expect newest first
-
- pass
-
-
-class EventStreamPermissionsTestCase(RestTestCase):
- """ Tests event streaming (GET /events). """
-
- @defer.inlineCallbacks
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- db_pool = SQLiteMemoryDbPool()
- yield db_pool.prepare()
-
- hs = HomeServer(
- "test",
- db_pool=db_pool,
- http_client=None,
- replication_layer=Mock(),
- clock=Mock(spec=[
- "call_later",
- "cancel_call_later",
- "time_msec",
- "time"
- ]),
- ratelimiter=NonCallableMock(spec_set=[
- "send_message",
- ]),
- config=self.mock_config,
- )
- self.ratelimiter = hs.get_ratelimiter()
- self.ratelimiter.send_message.return_value = (True, 0)
- hs.config.enable_registration_captcha = False
-
- hs.get_handlers().federation_handler = Mock()
-
- hs.get_clock().time_msec.return_value = 1000000
- hs.get_clock().time.return_value = 1000
-
- synapse.rest.register.register_servlets(hs, self.mock_resource)
- synapse.rest.events.register_servlets(hs, self.mock_resource)
- synapse.rest.room.register_servlets(hs, self.mock_resource)
-
- # register an account
- self.user_id = "sid1"
- response = yield self.register(self.user_id)
- self.token = response["access_token"]
- self.user_id = response["user_id"]
-
- # register a 2nd account
- self.other_user = "other1"
- response = yield self.register(self.other_user)
- self.other_token = response["access_token"]
- self.other_user = response["user_id"]
-
- def tearDown(self):
- pass
-
- @defer.inlineCallbacks
- def test_stream_basic_permissions(self):
- # invalid token, expect 403
- (code, response) = yield self.mock_resource.trigger_get(
- "/events?access_token=%s" % ("invalid" + self.token, )
- )
- self.assertEquals(403, code, msg=str(response))
-
- # valid token, expect content
- (code, response) = yield self.mock_resource.trigger_get(
- "/events?access_token=%s&timeout=0" % (self.token,)
- )
- self.assertEquals(200, code, msg=str(response))
- self.assertTrue("chunk" in response)
- self.assertTrue("start" in response)
- self.assertTrue("end" in response)
-
- @defer.inlineCallbacks
- def test_stream_room_permissions(self):
- room_id = yield self.create_room_as(
- self.other_user,
- tok=self.other_token
- )
- yield self.send(room_id, tok=self.other_token)
-
- # invited to room (expect no content for room)
- yield self.invite(
- room_id,
- src=self.other_user,
- targ=self.user_id,
- tok=self.other_token
- )
-
- (code, response) = yield self.mock_resource.trigger_get(
- "/events?access_token=%s&timeout=0" % (self.token,)
- )
- self.assertEquals(200, code, msg=str(response))
-
- self.assertEquals(0, len(response["chunk"]))
-
- # joined room (expect all content for room)
- yield self.join(room=room_id, user=self.user_id, tok=self.token)
-
- # left to room (expect no content for room)
-
- def TODO_test_stream_items(self):
- # new user, no content
-
- # join room, expect 1 item (join)
-
- # send message, expect 2 items (join,send)
-
- # set topic, expect 3 items (join,send,topic)
-
- # someone else join room, expect 4 (join,send,topic,join)
-
- # someone else send message, expect 5 (join,send.topic,join,send)
-
- # someone else set topic, expect 6 (join,send,topic,join,send,topic)
- pass
diff --git a/tests/rest/test_presence.py b/tests/rest/test_presence.py
deleted file mode 100644
index 769c7824bc..0000000000
--- a/tests/rest/test_presence.py
+++ /dev/null
@@ -1,372 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2014 OpenMarket Ltd
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Tests REST events for /presence paths."""
-
-from tests import unittest
-from twisted.internet import defer
-
-from mock import Mock
-
-from ..utils import MockHttpResource, MockKey
-
-from synapse.api.constants import PresenceState
-from synapse.handlers.presence import PresenceHandler
-from synapse.server import HomeServer
-
-
-OFFLINE = PresenceState.OFFLINE
-UNAVAILABLE = PresenceState.UNAVAILABLE
-ONLINE = PresenceState.ONLINE
-
-
-myid = "@apple:test"
-PATH_PREFIX = "/_matrix/client/api/v1"
-
-
-class JustPresenceHandlers(object):
- def __init__(self, hs):
- self.presence_handler = PresenceHandler(hs)
-
-
-class PresenceStateTestCase(unittest.TestCase):
-
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
- self.mock_config = Mock()
- self.mock_config.signing_key = [MockKey()]
- hs = HomeServer("test",
- db_pool=None,
- datastore=Mock(spec=[
- "get_presence_state",
- "set_presence_state",
- "insert_client_ip",
- ]),
- http_client=None,
- resource_for_client=self.mock_resource,
- resource_for_federation=self.mock_resource,
- config=self.mock_config,
- )
- hs.handlers = JustPresenceHandlers(hs)
-
- self.datastore = hs.get_datastore()
-
- def get_presence_list(*a, **kw):
- return defer.succeed([])
- self.datastore.get_presence_list = get_presence_list
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(myid),
- "admin": False,
- "device_id": None,
- }
-
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- room_member_handler = hs.handlers.room_member_handler = Mock(
- spec=[
- "get_rooms_for_user",
- ]
- )
-
- def get_rooms_for_user(user):
- return defer.succeed([])
- room_member_handler.get_rooms_for_user = get_rooms_for_user
-
- hs.register_servlets()
-
- self.u_apple = hs.parse_userid(myid)
-
- @defer.inlineCallbacks
- def test_get_my_status(self):
- mocked_get = self.datastore.get_presence_state
- mocked_get.return_value = defer.succeed(
- {"state": ONLINE, "status_msg": "Available"}
- )
-
- (code, response) = yield self.mock_resource.trigger("GET",
- "/presence/%s/status" % (myid), None)
-
- self.assertEquals(200, code)
- self.assertEquals(
- {"presence": ONLINE, "status_msg": "Available"},
- response
- )
- mocked_get.assert_called_with("apple")
-
- @defer.inlineCallbacks
- def test_set_my_status(self):
- mocked_set = self.datastore.set_presence_state
- mocked_set.return_value = defer.succeed({"state": OFFLINE})
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- "/presence/%s/status" % (myid),
- '{"presence": "unavailable", "status_msg": "Away"}')
-
- self.assertEquals(200, code)
- mocked_set.assert_called_with("apple",
- {"state": UNAVAILABLE, "status_msg": "Away"}
- )
-
-
-class PresenceListTestCase(unittest.TestCase):
-
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
- self.mock_config = Mock()
- self.mock_config.signing_key = [MockKey()]
-
- hs = HomeServer("test",
- db_pool=None,
- datastore=Mock(spec=[
- "has_presence_state",
- "get_presence_state",
- "allow_presence_visible",
- "is_presence_visible",
- "add_presence_list_pending",
- "set_presence_list_accepted",
- "del_presence_list",
- "get_presence_list",
- "insert_client_ip",
- ]),
- http_client=None,
- resource_for_client=self.mock_resource,
- resource_for_federation=self.mock_resource,
- config=self.mock_config,
- )
- hs.handlers = JustPresenceHandlers(hs)
-
- self.datastore = hs.get_datastore()
-
- def has_presence_state(user_localpart):
- return defer.succeed(
- user_localpart in ("apple", "banana",)
- )
- self.datastore.has_presence_state = has_presence_state
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(myid),
- "admin": False,
- "device_id": None,
- }
-
- room_member_handler = hs.handlers.room_member_handler = Mock(
- spec=[
- "get_rooms_for_user",
- ]
- )
-
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- hs.register_servlets()
-
- self.u_apple = hs.parse_userid("@apple:test")
- self.u_banana = hs.parse_userid("@banana:test")
-
- @defer.inlineCallbacks
- def test_get_my_list(self):
- self.datastore.get_presence_list.return_value = defer.succeed(
- [{"observed_user_id": "@banana:test"}],
- )
-
- (code, response) = yield self.mock_resource.trigger("GET",
- "/presence/list/%s" % (myid), None)
-
- self.assertEquals(200, code)
- self.assertEquals([
- {"user_id": "@banana:test", "presence": OFFLINE},
- ], response)
-
- self.datastore.get_presence_list.assert_called_with(
- "apple", accepted=True
- )
-
- @defer.inlineCallbacks
- def test_invite(self):
- self.datastore.add_presence_list_pending.return_value = (
- defer.succeed(())
- )
- self.datastore.is_presence_visible.return_value = defer.succeed(
- True
- )
-
- (code, response) = yield self.mock_resource.trigger("POST",
- "/presence/list/%s" % (myid),
- """{"invite": ["@banana:test"]}"""
- )
-
- self.assertEquals(200, code)
-
- self.datastore.add_presence_list_pending.assert_called_with(
- "apple", "@banana:test"
- )
- self.datastore.set_presence_list_accepted.assert_called_with(
- "apple", "@banana:test"
- )
-
- @defer.inlineCallbacks
- def test_drop(self):
- self.datastore.del_presence_list.return_value = (
- defer.succeed(())
- )
-
- (code, response) = yield self.mock_resource.trigger("POST",
- "/presence/list/%s" % (myid),
- """{"drop": ["@banana:test"]}"""
- )
-
- self.assertEquals(200, code)
-
- self.datastore.del_presence_list.assert_called_with(
- "apple", "@banana:test"
- )
-
-
-class PresenceEventStreamTestCase(unittest.TestCase):
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
-
- self.mock_config = Mock()
- self.mock_config.signing_key = [MockKey()]
-
- # HIDEOUS HACKERY
- # TODO(paul): This should be injected in via the HomeServer DI system
- from synapse.streams.events import (
- PresenceEventSource, NullSource, EventSources
- )
-
- old_SOURCE_TYPES = EventSources.SOURCE_TYPES
- def tearDown():
- EventSources.SOURCE_TYPES = old_SOURCE_TYPES
- self.tearDown = tearDown
-
- EventSources.SOURCE_TYPES = {
- k: NullSource for k in old_SOURCE_TYPES.keys()
- }
- EventSources.SOURCE_TYPES["presence"] = PresenceEventSource
-
- hs = HomeServer("test",
- db_pool=None,
- http_client=None,
- resource_for_client=self.mock_resource,
- resource_for_federation=self.mock_resource,
- datastore=Mock(spec=[
- "set_presence_state",
- "get_presence_list",
- ]),
- clock=Mock(spec=[
- "call_later",
- "cancel_call_later",
- "time_msec",
- ]),
- config=self.mock_config,
- )
-
- hs.get_clock().time_msec.return_value = 1000000
-
- def _get_user_by_req(req=None):
- return hs.parse_userid(myid)
-
- hs.get_auth().get_user_by_req = _get_user_by_req
-
- hs.register_servlets()
-
- hs.handlers.room_member_handler = Mock(spec=[])
-
- self.room_members = []
-
- def get_rooms_for_user(user):
- if user in self.room_members:
- return ["a-room"]
- else:
- return []
- hs.handlers.room_member_handler.get_rooms_for_user = get_rooms_for_user
-
- self.mock_datastore = hs.get_datastore()
-
- def get_profile_displayname(user_id):
- return defer.succeed("Frank")
- self.mock_datastore.get_profile_displayname = get_profile_displayname
-
- def get_profile_avatar_url(user_id):
- return defer.succeed(None)
- self.mock_datastore.get_profile_avatar_url = get_profile_avatar_url
-
- def user_rooms_intersect(user_list):
- room_member_ids = map(lambda u: u.to_string(), self.room_members)
-
- shared = all(map(lambda i: i in room_member_ids, user_list))
- return defer.succeed(shared)
- self.mock_datastore.user_rooms_intersect = user_rooms_intersect
-
- def get_joined_hosts_for_room(room_id):
- return []
- self.mock_datastore.get_joined_hosts_for_room = get_joined_hosts_for_room
-
- self.presence = hs.get_handlers().presence_handler
-
- self.u_apple = hs.parse_userid("@apple:test")
- self.u_banana = hs.parse_userid("@banana:test")
-
- @defer.inlineCallbacks
- def test_shortpoll(self):
- self.room_members = [self.u_apple, self.u_banana]
-
- self.mock_datastore.set_presence_state.return_value = defer.succeed(
- {"state": ONLINE}
- )
- self.mock_datastore.get_presence_list.return_value = defer.succeed(
- []
- )
-
- (code, response) = yield self.mock_resource.trigger("GET",
- "/events?timeout=0", None)
-
- self.assertEquals(200, code)
-
- # We've forced there to be only one data stream so the tokens will
- # all be ours
-
- # I'll already get my own presence state change
- self.assertEquals({"start": "0_1_0", "end": "0_1_0", "chunk": []},
- response
- )
-
- self.mock_datastore.set_presence_state.return_value = defer.succeed(
- {"state": ONLINE}
- )
- self.mock_datastore.get_presence_list.return_value = defer.succeed(
- []
- )
-
- yield self.presence.set_state(self.u_banana, self.u_banana,
- state={"presence": ONLINE}
- )
-
- (code, response) = yield self.mock_resource.trigger("GET",
- "/events?from=0_1_0&timeout=0", None)
-
- self.assertEquals(200, code)
- self.assertEquals({"start": "0_1_0", "end": "0_2_0", "chunk": [
- {"type": "m.presence",
- "content": {
- "user_id": "@banana:test",
- "presence": ONLINE,
- "displayname": "Frank",
- "last_active_ago": 0,
- }},
- ]}, response)
diff --git a/tests/rest/test_profile.py b/tests/rest/test_profile.py
deleted file mode 100644
index 3a0d1e700a..0000000000
--- a/tests/rest/test_profile.py
+++ /dev/null
@@ -1,150 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2014 OpenMarket Ltd
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Tests REST events for /profile paths."""
-
-from tests import unittest
-from twisted.internet import defer
-
-from mock import Mock, NonCallableMock
-
-from ..utils import MockHttpResource, MockKey
-
-from synapse.api.errors import SynapseError, AuthError
-from synapse.server import HomeServer
-
-myid = "@1234ABCD:test"
-PATH_PREFIX = "/_matrix/client/api/v1"
-
-
-class ProfileTestCase(unittest.TestCase):
- """ Tests profile management. """
-
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
- self.mock_handler = Mock(spec=[
- "get_displayname",
- "set_displayname",
- "get_avatar_url",
- "set_avatar_url",
- ])
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- hs = HomeServer("test",
- db_pool=None,
- http_client=None,
- resource_for_client=self.mock_resource,
- federation=Mock(),
- replication_layer=Mock(),
- datastore=None,
- config=self.mock_config,
- )
-
- def _get_user_by_req(request=None):
- return hs.parse_userid(myid)
-
- hs.get_auth().get_user_by_req = _get_user_by_req
-
- hs.get_handlers().profile_handler = self.mock_handler
-
- hs.register_servlets()
-
- @defer.inlineCallbacks
- def test_get_my_name(self):
- mocked_get = self.mock_handler.get_displayname
- mocked_get.return_value = defer.succeed("Frank")
-
- (code, response) = yield self.mock_resource.trigger("GET",
- "/profile/%s/displayname" % (myid), None)
-
- self.assertEquals(200, code)
- self.assertEquals({"displayname": "Frank"}, response)
- self.assertEquals(mocked_get.call_args[0][0].localpart, "1234ABCD")
-
- @defer.inlineCallbacks
- def test_set_my_name(self):
- mocked_set = self.mock_handler.set_displayname
- mocked_set.return_value = defer.succeed(())
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- "/profile/%s/displayname" % (myid),
- '{"displayname": "Frank Jr."}')
-
- self.assertEquals(200, code)
- self.assertEquals(mocked_set.call_args[0][0].localpart, "1234ABCD")
- self.assertEquals(mocked_set.call_args[0][1].localpart, "1234ABCD")
- self.assertEquals(mocked_set.call_args[0][2], "Frank Jr.")
-
- @defer.inlineCallbacks
- def test_set_my_name_noauth(self):
- mocked_set = self.mock_handler.set_displayname
- mocked_set.side_effect = AuthError(400, "message")
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- "/profile/%s/displayname" % ("@4567:test"), '"Frank Jr."')
-
- self.assertTrue(400 <= code < 499,
- msg="code %d is in the 4xx range" % (code))
-
- @defer.inlineCallbacks
- def test_get_other_name(self):
- mocked_get = self.mock_handler.get_displayname
- mocked_get.return_value = defer.succeed("Bob")
-
- (code, response) = yield self.mock_resource.trigger("GET",
- "/profile/%s/displayname" % ("@opaque:elsewhere"), None)
-
- self.assertEquals(200, code)
- self.assertEquals({"displayname": "Bob"}, response)
-
- @defer.inlineCallbacks
- def test_set_other_name(self):
- mocked_set = self.mock_handler.set_displayname
- mocked_set.side_effect = SynapseError(400, "message")
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- "/profile/%s/displayname" % ("@opaque:elsewhere"), None)
-
- self.assertTrue(400 <= code <= 499,
- msg="code %d is in the 4xx range" % (code))
-
- @defer.inlineCallbacks
- def test_get_my_avatar(self):
- mocked_get = self.mock_handler.get_avatar_url
- mocked_get.return_value = defer.succeed("http://my.server/me.png")
-
- (code, response) = yield self.mock_resource.trigger("GET",
- "/profile/%s/avatar_url" % (myid), None)
-
- self.assertEquals(200, code)
- self.assertEquals({"avatar_url": "http://my.server/me.png"}, response)
- self.assertEquals(mocked_get.call_args[0][0].localpart, "1234ABCD")
-
- @defer.inlineCallbacks
- def test_set_my_avatar(self):
- mocked_set = self.mock_handler.set_avatar_url
- mocked_set.return_value = defer.succeed(())
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- "/profile/%s/avatar_url" % (myid),
- '{"avatar_url": "http://my.server/pic.gif"}')
-
- self.assertEquals(200, code)
- self.assertEquals(mocked_set.call_args[0][0].localpart, "1234ABCD")
- self.assertEquals(mocked_set.call_args[0][1].localpart, "1234ABCD")
- self.assertEquals(mocked_set.call_args[0][2],
- "http://my.server/pic.gif")
diff --git a/tests/rest/test_rooms.py b/tests/rest/test_rooms.py
deleted file mode 100644
index 8e65ff9a1c..0000000000
--- a/tests/rest/test_rooms.py
+++ /dev/null
@@ -1,1068 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2014 OpenMarket Ltd
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Tests REST events for /rooms paths."""
-
-# twisted imports
-from twisted.internet import defer
-
-import synapse.rest.room
-from synapse.api.constants import Membership
-
-from synapse.server import HomeServer
-
-from tests import unittest
-
-# python imports
-import json
-import urllib
-import types
-
-from ..utils import MockHttpResource, SQLiteMemoryDbPool, MockKey
-from .utils import RestTestCase
-
-from mock import Mock, NonCallableMock
-
-PATH_PREFIX = "/_matrix/client/api/v1"
-
-
-class RoomPermissionsTestCase(RestTestCase):
- """ Tests room permissions. """
- user_id = "@sid1:red"
- rmcreator_id = "@notme:red"
-
- @defer.inlineCallbacks
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- db_pool = SQLiteMemoryDbPool()
- yield db_pool.prepare()
-
- hs = HomeServer(
- "red",
- db_pool=db_pool,
- http_client=None,
- replication_layer=Mock(),
- ratelimiter=NonCallableMock(spec_set=[
- "send_message",
- ]),
- config=self.mock_config,
- )
- self.ratelimiter = hs.get_ratelimiter()
- self.ratelimiter.send_message.return_value = (True, 0)
-
- hs.get_handlers().federation_handler = Mock()
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(self.auth_user_id),
- "admin": False,
- "device_id": None,
- }
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- def _insert_client_ip(*args, **kwargs):
- return defer.succeed(None)
- hs.get_datastore().insert_client_ip = _insert_client_ip
-
- self.auth_user_id = self.rmcreator_id
-
- synapse.rest.room.register_servlets(hs, self.mock_resource)
-
- self.auth = hs.get_auth()
-
- # create some rooms under the name rmcreator_id
- self.uncreated_rmid = "!aa:test"
-
- self.created_rmid = yield self.create_room_as(self.rmcreator_id,
- is_public=False)
-
- self.created_public_rmid = yield self.create_room_as(self.rmcreator_id,
- is_public=True)
-
- # send a message in one of the rooms
- self.created_rmid_msg_path = ("/rooms/%s/send/m.room.message/a1" %
- (self.created_rmid))
- (code, response) = yield self.mock_resource.trigger(
- "PUT",
- self.created_rmid_msg_path,
- '{"msgtype":"m.text","body":"test msg"}')
- self.assertEquals(200, code, msg=str(response))
-
- # set topic for public room
- (code, response) = yield self.mock_resource.trigger(
- "PUT",
- "/rooms/%s/state/m.room.topic" % self.created_public_rmid,
- '{"topic":"Public Room Topic"}')
- self.assertEquals(200, code, msg=str(response))
-
- # auth as user_id now
- self.auth_user_id = self.user_id
-
- def tearDown(self):
- pass
-
-# @defer.inlineCallbacks
-# def test_get_message(self):
-# # get message in uncreated room, expect 403
-# (code, response) = yield self.mock_resource.trigger_get(
-# "/rooms/noroom/messages/someid/m1")
-# self.assertEquals(403, code, msg=str(response))
-#
-# # get message in created room not joined (no state), expect 403
-# (code, response) = yield self.mock_resource.trigger_get(
-# self.created_rmid_msg_path)
-# self.assertEquals(403, code, msg=str(response))
-#
-# # get message in created room and invited, expect 403
-# yield self.invite(room=self.created_rmid, src=self.rmcreator_id,
-# targ=self.user_id)
-# (code, response) = yield self.mock_resource.trigger_get(
-# self.created_rmid_msg_path)
-# self.assertEquals(403, code, msg=str(response))
-#
-# # get message in created room and joined, expect 200
-# yield self.join(room=self.created_rmid, user=self.user_id)
-# (code, response) = yield self.mock_resource.trigger_get(
-# self.created_rmid_msg_path)
-# self.assertEquals(200, code, msg=str(response))
-#
-# # get message in created room and left, expect 403
-# yield self.leave(room=self.created_rmid, user=self.user_id)
-# (code, response) = yield self.mock_resource.trigger_get(
-# self.created_rmid_msg_path)
-# self.assertEquals(403, code, msg=str(response))
-
- @defer.inlineCallbacks
- def test_send_message(self):
- msg_content = '{"msgtype":"m.text","body":"hello"}'
- send_msg_path = (
- "/rooms/%s/send/m.room.message/mid1" % (self.created_rmid,)
- )
-
- # send message in uncreated room, expect 403
- (code, response) = yield self.mock_resource.trigger(
- "PUT",
- "/rooms/%s/send/m.room.message/mid2" % (self.uncreated_rmid,),
- msg_content
- )
- self.assertEquals(403, code, msg=str(response))
-
- # send message in created room not joined (no state), expect 403
- (code, response) = yield self.mock_resource.trigger(
- "PUT",
- send_msg_path,
- msg_content
- )
- self.assertEquals(403, code, msg=str(response))
-
- # send message in created room and invited, expect 403
- yield self.invite(
- room=self.created_rmid,
- src=self.rmcreator_id,
- targ=self.user_id
- )
- (code, response) = yield self.mock_resource.trigger(
- "PUT",
- send_msg_path,
- msg_content
- )
- self.assertEquals(403, code, msg=str(response))
-
- # send message in created room and joined, expect 200
- yield self.join(room=self.created_rmid, user=self.user_id)
- (code, response) = yield self.mock_resource.trigger(
- "PUT",
- send_msg_path,
- msg_content
- )
- self.assertEquals(200, code, msg=str(response))
-
- # send message in created room and left, expect 403
- yield self.leave(room=self.created_rmid, user=self.user_id)
- (code, response) = yield self.mock_resource.trigger(
- "PUT",
- send_msg_path,
- msg_content
- )
- self.assertEquals(403, code, msg=str(response))
-
- @defer.inlineCallbacks
- def test_topic_perms(self):
- topic_content = '{"topic":"My Topic Name"}'
- topic_path = "/rooms/%s/state/m.room.topic" % self.created_rmid
-
- # set/get topic in uncreated room, expect 403
- (code, response) = yield self.mock_resource.trigger(
- "PUT", "/rooms/%s/state/m.room.topic" % self.uncreated_rmid,
- topic_content)
- self.assertEquals(403, code, msg=str(response))
- (code, response) = yield self.mock_resource.trigger_get(
- "/rooms/%s/state/m.room.topic" % self.uncreated_rmid)
- self.assertEquals(403, code, msg=str(response))
-
- # set/get topic in created PRIVATE room not joined, expect 403
- (code, response) = yield self.mock_resource.trigger(
- "PUT", topic_path, topic_content)
- self.assertEquals(403, code, msg=str(response))
- (code, response) = yield self.mock_resource.trigger_get(topic_path)
- self.assertEquals(403, code, msg=str(response))
-
- # set topic in created PRIVATE room and invited, expect 403
- yield self.invite(room=self.created_rmid, src=self.rmcreator_id,
- targ=self.user_id)
- (code, response) = yield self.mock_resource.trigger(
- "PUT", topic_path, topic_content)
- self.assertEquals(403, code, msg=str(response))
-
- # get topic in created PRIVATE room and invited, expect 403
- (code, response) = yield self.mock_resource.trigger_get(topic_path)
- self.assertEquals(403, code, msg=str(response))
-
- # set/get topic in created PRIVATE room and joined, expect 200
- yield self.join(room=self.created_rmid, user=self.user_id)
-
- # Only room ops can set topic by default
- self.auth_user_id = self.rmcreator_id
- (code, response) = yield self.mock_resource.trigger(
- "PUT", topic_path, topic_content)
- self.assertEquals(200, code, msg=str(response))
- self.auth_user_id = self.user_id
-
- (code, response) = yield self.mock_resource.trigger_get(topic_path)
- self.assertEquals(200, code, msg=str(response))
- self.assert_dict(json.loads(topic_content), response)
-
- # set/get topic in created PRIVATE room and left, expect 403
- yield self.leave(room=self.created_rmid, user=self.user_id)
- (code, response) = yield self.mock_resource.trigger(
- "PUT", topic_path, topic_content)
- self.assertEquals(403, code, msg=str(response))
- (code, response) = yield self.mock_resource.trigger_get(topic_path)
- self.assertEquals(403, code, msg=str(response))
-
- # get topic in PUBLIC room, not joined, expect 403
- (code, response) = yield self.mock_resource.trigger_get(
- "/rooms/%s/state/m.room.topic" % self.created_public_rmid)
- self.assertEquals(403, code, msg=str(response))
-
- # set topic in PUBLIC room, not joined, expect 403
- (code, response) = yield self.mock_resource.trigger(
- "PUT",
- "/rooms/%s/state/m.room.topic" % self.created_public_rmid,
- topic_content)
- self.assertEquals(403, code, msg=str(response))
-
- @defer.inlineCallbacks
- def _test_get_membership(self, room=None, members=[], expect_code=None):
- path = "/rooms/%s/state/m.room.member/%s"
- for member in members:
- (code, response) = yield self.mock_resource.trigger_get(
- path %
- (room, member))
- self.assertEquals(expect_code, code)
-
- @defer.inlineCallbacks
- 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
- yield self._test_get_membership(
- members=[self.user_id, self.rmcreator_id],
- room=room, expect_code=403)
-
- # trying to invite people to this room should 403
- yield self.invite(room=room, src=self.user_id, targ=self.rmcreator_id,
- expect_code=403)
-
- # set [invite/join/left] of self, set [invite/join/left] of other,
- # expect all 403s
- for usr in [self.user_id, self.rmcreator_id]:
- yield self.join(room=room, user=usr, expect_code=404)
- yield self.leave(room=room, user=usr, expect_code=403)
-
- @defer.inlineCallbacks
- 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
- yield self.invite(room=room, src=self.rmcreator_id,
- targ=self.user_id)
- yield self._test_get_membership(
- members=[self.user_id, self.rmcreator_id],
- room=room, expect_code=403)
-
- # get membership of self, get membership of other, private room + joined
- # expect all 200s
- yield self.join(room=room, user=self.user_id)
- yield self._test_get_membership(
- members=[self.user_id, self.rmcreator_id],
- room=room, expect_code=200)
-
- # get membership of self, get membership of other, private room + left
- # expect all 403s
- yield self.leave(room=room, user=self.user_id)
- yield self._test_get_membership(
- members=[self.user_id, self.rmcreator_id],
- room=room, expect_code=403)
-
- @defer.inlineCallbacks
- 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
- yield self.invite(room=room, src=self.rmcreator_id,
- targ=self.user_id)
- yield self._test_get_membership(
- members=[self.user_id, self.rmcreator_id],
- room=room, expect_code=403)
-
- # get membership of self, get membership of other, public room + joined
- # expect all 200s
- yield self.join(room=room, user=self.user_id)
- yield self._test_get_membership(
- members=[self.user_id, self.rmcreator_id],
- room=room, expect_code=200)
-
- # get membership of self, get membership of other, public room + left
- # expect 403.
- yield self.leave(room=room, user=self.user_id)
- yield self._test_get_membership(
- members=[self.user_id, self.rmcreator_id],
- room=room, expect_code=403)
-
- @defer.inlineCallbacks
- def test_invited_permissions(self):
- room = self.created_rmid
- yield self.invite(room=room, src=self.rmcreator_id, targ=self.user_id)
-
- # set [invite/join/left] of other user, expect 403s
- yield self.invite(room=room, src=self.user_id, targ=self.rmcreator_id,
- expect_code=403)
- yield self.change_membership(room=room, src=self.user_id,
- targ=self.rmcreator_id,
- membership=Membership.JOIN,
- expect_code=403)
- yield self.change_membership(room=room, src=self.user_id,
- targ=self.rmcreator_id,
- membership=Membership.LEAVE,
- expect_code=403)
-
- @defer.inlineCallbacks
- def test_joined_permissions(self):
- room = self.created_rmid
- yield self.invite(room=room, src=self.rmcreator_id, targ=self.user_id)
- yield self.join(room=room, user=self.user_id)
-
- # set invited of self, expect 403
- yield self.invite(room=room, src=self.user_id, targ=self.user_id,
- expect_code=403)
-
- # set joined of self, expect 200 (NOOP)
- yield self.join(room=room, user=self.user_id)
-
- other = "@burgundy:red"
- # set invited of other, expect 200
- yield self.invite(room=room, src=self.user_id, targ=other,
- expect_code=200)
-
- # set joined of other, expect 403
- yield self.change_membership(room=room, src=self.user_id,
- targ=other,
- membership=Membership.JOIN,
- expect_code=403)
-
- # set left of other, expect 403
- yield self.change_membership(room=room, src=self.user_id,
- targ=other,
- membership=Membership.LEAVE,
- expect_code=403)
-
- # set left of self, expect 200
- yield self.leave(room=room, user=self.user_id)
-
- @defer.inlineCallbacks
- def test_leave_permissions(self):
- room = self.created_rmid
- yield self.invite(room=room, src=self.rmcreator_id, targ=self.user_id)
- yield self.join(room=room, user=self.user_id)
- yield self.leave(room=room, user=self.user_id)
-
- # set [invite/join/left] of self, set [invite/join/left] of other,
- # expect all 403s
- for usr in [self.user_id, self.rmcreator_id]:
- yield self.change_membership(
- room=room,
- src=self.user_id,
- targ=usr,
- membership=Membership.INVITE,
- expect_code=403
- )
-
- yield self.change_membership(
- room=room,
- src=self.user_id,
- targ=usr,
- membership=Membership.JOIN,
- expect_code=403
- )
-
- # It is always valid to LEAVE if you've already left (currently.)
- yield self.change_membership(
- room=room,
- src=self.user_id,
- targ=self.rmcreator_id,
- membership=Membership.LEAVE,
- expect_code=403
- )
-
-
-class RoomsMemberListTestCase(RestTestCase):
- """ Tests /rooms/$room_id/members/list REST events."""
- user_id = "@sid1:red"
-
- @defer.inlineCallbacks
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- db_pool = SQLiteMemoryDbPool()
- yield db_pool.prepare()
-
- hs = HomeServer(
- "red",
- db_pool=db_pool,
- http_client=None,
- replication_layer=Mock(),
- ratelimiter=NonCallableMock(spec_set=[
- "send_message",
- ]),
- config=self.mock_config,
- )
- self.ratelimiter = hs.get_ratelimiter()
- self.ratelimiter.send_message.return_value = (True, 0)
-
- hs.get_handlers().federation_handler = Mock()
-
- self.auth_user_id = self.user_id
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(self.auth_user_id),
- "admin": False,
- "device_id": None,
- }
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- def _insert_client_ip(*args, **kwargs):
- return defer.succeed(None)
- hs.get_datastore().insert_client_ip = _insert_client_ip
-
- synapse.rest.room.register_servlets(hs, self.mock_resource)
-
- def tearDown(self):
- pass
-
- @defer.inlineCallbacks
- def test_get_member_list(self):
- room_id = yield self.create_room_as(self.user_id)
- (code, response) = yield self.mock_resource.trigger_get(
- "/rooms/%s/members" % room_id)
- self.assertEquals(200, code, msg=str(response))
-
- @defer.inlineCallbacks
- def test_get_member_list_no_room(self):
- (code, response) = yield self.mock_resource.trigger_get(
- "/rooms/roomdoesnotexist/members")
- self.assertEquals(403, code, msg=str(response))
-
- @defer.inlineCallbacks
- def test_get_member_list_no_permission(self):
- room_id = yield self.create_room_as("@some_other_guy:red")
- (code, response) = yield self.mock_resource.trigger_get(
- "/rooms/%s/members" % room_id)
- self.assertEquals(403, code, msg=str(response))
-
- @defer.inlineCallbacks
- def test_get_member_list_mixed_memberships(self):
- room_creator = "@some_other_guy:red"
- room_id = yield self.create_room_as(room_creator)
- room_path = "/rooms/%s/members" % room_id
- yield self.invite(room=room_id, src=room_creator,
- targ=self.user_id)
- # can't see list if you're just invited.
- (code, response) = yield self.mock_resource.trigger_get(room_path)
- self.assertEquals(403, code, msg=str(response))
-
- yield self.join(room=room_id, user=self.user_id)
- # can see list now joined
- (code, response) = yield self.mock_resource.trigger_get(room_path)
- self.assertEquals(200, code, msg=str(response))
-
- yield self.leave(room=room_id, user=self.user_id)
- # can no longer see list, you've left.
- (code, response) = yield self.mock_resource.trigger_get(room_path)
- self.assertEquals(403, code, msg=str(response))
-
-
-class RoomsCreateTestCase(RestTestCase):
- """ Tests /rooms and /rooms/$room_id REST events. """
- user_id = "@sid1:red"
-
- @defer.inlineCallbacks
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
- self.auth_user_id = self.user_id
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- db_pool = SQLiteMemoryDbPool()
- yield db_pool.prepare()
-
- hs = HomeServer(
- "red",
- db_pool=db_pool,
- http_client=None,
- replication_layer=Mock(),
- ratelimiter=NonCallableMock(spec_set=[
- "send_message",
- ]),
- config=self.mock_config,
- )
- self.ratelimiter = hs.get_ratelimiter()
- self.ratelimiter.send_message.return_value = (True, 0)
-
- hs.get_handlers().federation_handler = Mock()
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(self.auth_user_id),
- "admin": False,
- "device_id": None,
- }
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- def _insert_client_ip(*args, **kwargs):
- return defer.succeed(None)
- hs.get_datastore().insert_client_ip = _insert_client_ip
-
- synapse.rest.room.register_servlets(hs, self.mock_resource)
-
- def tearDown(self):
- pass
-
- @defer.inlineCallbacks
- def test_post_room_no_keys(self):
- # POST with no config keys, expect new room id
- (code, response) = yield self.mock_resource.trigger("POST",
- "/createRoom",
- "{}")
- self.assertEquals(200, code, response)
- self.assertTrue("room_id" in response)
-
- @defer.inlineCallbacks
- def test_post_room_visibility_key(self):
- # POST with visibility config key, expect new room id
- (code, response) = yield self.mock_resource.trigger(
- "POST",
- "/createRoom",
- '{"visibility":"private"}')
- self.assertEquals(200, code)
- self.assertTrue("room_id" in response)
-
- @defer.inlineCallbacks
- def test_post_room_custom_key(self):
- # POST with custom config keys, expect new room id
- (code, response) = yield self.mock_resource.trigger(
- "POST",
- "/createRoom",
- '{"custom":"stuff"}')
- self.assertEquals(200, code)
- self.assertTrue("room_id" in response)
-
- @defer.inlineCallbacks
- def test_post_room_known_and_unknown_keys(self):
- # POST with custom + known config keys, expect new room id
- (code, response) = yield self.mock_resource.trigger(
- "POST",
- "/createRoom",
- '{"visibility":"private","custom":"things"}')
- self.assertEquals(200, code)
- self.assertTrue("room_id" in response)
-
- @defer.inlineCallbacks
- def test_post_room_invalid_content(self):
- # POST with invalid content / paths, expect 400
- (code, response) = yield self.mock_resource.trigger(
- "POST",
- "/createRoom",
- '{"visibili')
- self.assertEquals(400, code)
-
- (code, response) = yield self.mock_resource.trigger(
- "POST",
- "/createRoom",
- '["hello"]')
- self.assertEquals(400, code)
-
-
-class RoomTopicTestCase(RestTestCase):
- """ Tests /rooms/$room_id/topic REST events. """
- user_id = "@sid1:red"
-
- @defer.inlineCallbacks
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
- self.auth_user_id = self.user_id
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- db_pool = SQLiteMemoryDbPool()
- yield db_pool.prepare()
-
- hs = HomeServer(
- "red",
- db_pool=db_pool,
- http_client=None,
- replication_layer=Mock(),
- ratelimiter=NonCallableMock(spec_set=[
- "send_message",
- ]),
- config=self.mock_config,
- )
- self.ratelimiter = hs.get_ratelimiter()
- self.ratelimiter.send_message.return_value = (True, 0)
-
- hs.get_handlers().federation_handler = Mock()
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(self.auth_user_id),
- "admin": False,
- "device_id": None,
- }
-
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- def _insert_client_ip(*args, **kwargs):
- return defer.succeed(None)
- hs.get_datastore().insert_client_ip = _insert_client_ip
-
- synapse.rest.room.register_servlets(hs, self.mock_resource)
-
- # create the room
- self.room_id = yield self.create_room_as(self.user_id)
- self.path = "/rooms/%s/state/m.room.topic" % (self.room_id,)
-
- def tearDown(self):
- pass
-
- @defer.inlineCallbacks
- def test_invalid_puts(self):
- # missing keys or invalid json
- (code, response) = yield self.mock_resource.trigger("PUT",
- self.path, '{}')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- self.path, '{"_name":"bob"}')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- self.path, '{"nao')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- self.path, '[{"_name":"bob"},{"_name":"jill"}]')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- self.path, 'text only')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- self.path, '')
- self.assertEquals(400, code, msg=str(response))
-
- # valid key, wrong type
- content = '{"topic":["Topic name"]}'
- (code, response) = yield self.mock_resource.trigger("PUT",
- self.path, content)
- self.assertEquals(400, code, msg=str(response))
-
- @defer.inlineCallbacks
- def test_rooms_topic(self):
- # nothing should be there
- (code, response) = yield self.mock_resource.trigger_get(self.path)
- self.assertEquals(404, code, msg=str(response))
-
- # valid put
- content = '{"topic":"Topic name"}'
- (code, response) = yield self.mock_resource.trigger("PUT",
- self.path, content)
- self.assertEquals(200, code, msg=str(response))
-
- # valid get
- (code, response) = yield self.mock_resource.trigger_get(self.path)
- self.assertEquals(200, code, msg=str(response))
- self.assert_dict(json.loads(content), response)
-
- @defer.inlineCallbacks
- def test_rooms_topic_with_extra_keys(self):
- # valid put with extra keys
- content = '{"topic":"Seasons","subtopic":"Summer"}'
- (code, response) = yield self.mock_resource.trigger("PUT",
- self.path, content)
- self.assertEquals(200, code, msg=str(response))
-
- # valid get
- (code, response) = yield self.mock_resource.trigger_get(self.path)
- self.assertEquals(200, code, msg=str(response))
- self.assert_dict(json.loads(content), response)
-
-
-class RoomMemberStateTestCase(RestTestCase):
- """ Tests /rooms/$room_id/members/$user_id/state REST events. """
- user_id = "@sid1:red"
-
- @defer.inlineCallbacks
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
- self.auth_user_id = self.user_id
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- db_pool = SQLiteMemoryDbPool()
- yield db_pool.prepare()
-
- hs = HomeServer(
- "red",
- db_pool=db_pool,
- http_client=None,
- replication_layer=Mock(),
- ratelimiter=NonCallableMock(spec_set=[
- "send_message",
- ]),
- config=self.mock_config,
- )
- self.ratelimiter = hs.get_ratelimiter()
- self.ratelimiter.send_message.return_value = (True, 0)
-
- hs.get_handlers().federation_handler = Mock()
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(self.auth_user_id),
- "admin": False,
- "device_id": None,
- }
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- def _insert_client_ip(*args, **kwargs):
- return defer.succeed(None)
- hs.get_datastore().insert_client_ip = _insert_client_ip
-
- synapse.rest.room.register_servlets(hs, self.mock_resource)
-
- self.room_id = yield self.create_room_as(self.user_id)
-
- def tearDown(self):
- pass
-
- @defer.inlineCallbacks
- def test_invalid_puts(self):
- path = "/rooms/%s/state/m.room.member/%s" % (self.room_id, self.user_id)
- # missing keys or invalid json
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '{}')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '{"_name":"bob"}')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '{"nao')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '[{"_name":"bob"},{"_name":"jill"}]')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, 'text only')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '')
- self.assertEquals(400, code, msg=str(response))
-
- # valid keys, wrong types
- content = ('{"membership":["%s","%s","%s"]}' %
- (Membership.INVITE, Membership.JOIN, Membership.LEAVE))
- (code, response) = yield self.mock_resource.trigger("PUT", path, content)
- self.assertEquals(400, code, msg=str(response))
-
- @defer.inlineCallbacks
- def test_rooms_members_self(self):
- path = "/rooms/%s/state/m.room.member/%s" % (
- urllib.quote(self.room_id), self.user_id
- )
-
- # valid join message (NOOP since we made the room)
- content = '{"membership":"%s"}' % Membership.JOIN
- (code, response) = yield self.mock_resource.trigger("PUT", path, content)
- self.assertEquals(200, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("GET", path, None)
- self.assertEquals(200, code, msg=str(response))
-
- expected_response = {
- "membership": Membership.JOIN,
- }
- self.assertEquals(expected_response, response)
-
- @defer.inlineCallbacks
- def test_rooms_members_other(self):
- self.other_id = "@zzsid1:red"
- path = "/rooms/%s/state/m.room.member/%s" % (
- urllib.quote(self.room_id), self.other_id
- )
-
- # valid invite message
- content = '{"membership":"%s"}' % Membership.INVITE
- (code, response) = yield self.mock_resource.trigger("PUT", path, content)
- self.assertEquals(200, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("GET", path, None)
- self.assertEquals(200, code, msg=str(response))
- self.assertEquals(json.loads(content), response)
-
- @defer.inlineCallbacks
- def test_rooms_members_other_custom_keys(self):
- self.other_id = "@zzsid1:red"
- path = "/rooms/%s/state/m.room.member/%s" % (
- urllib.quote(self.room_id), self.other_id
- )
-
- # valid invite message with custom key
- content = ('{"membership":"%s","invite_text":"%s"}' %
- (Membership.INVITE, "Join us!"))
- (code, response) = yield self.mock_resource.trigger("PUT", path, content)
- self.assertEquals(200, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("GET", path, None)
- self.assertEquals(200, code, msg=str(response))
- self.assertEquals(json.loads(content), response)
-
-
-class RoomMessagesTestCase(RestTestCase):
- """ Tests /rooms/$room_id/messages/$user_id/$msg_id REST events. """
- user_id = "@sid1:red"
-
- @defer.inlineCallbacks
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
- self.auth_user_id = self.user_id
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- db_pool = SQLiteMemoryDbPool()
- yield db_pool.prepare()
-
- hs = HomeServer(
- "red",
- db_pool=db_pool,
- http_client=None,
- replication_layer=Mock(),
- ratelimiter=NonCallableMock(spec_set=[
- "send_message",
- ]),
- config=self.mock_config,
- )
- self.ratelimiter = hs.get_ratelimiter()
- self.ratelimiter.send_message.return_value = (True, 0)
-
- hs.get_handlers().federation_handler = Mock()
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(self.auth_user_id),
- "admin": False,
- "device_id": None,
- }
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- def _insert_client_ip(*args, **kwargs):
- return defer.succeed(None)
- hs.get_datastore().insert_client_ip = _insert_client_ip
-
- synapse.rest.room.register_servlets(hs, self.mock_resource)
-
- self.room_id = yield self.create_room_as(self.user_id)
-
- def tearDown(self):
- pass
-
- @defer.inlineCallbacks
- def test_invalid_puts(self):
- path = "/rooms/%s/send/m.room.message/mid1" % (
- urllib.quote(self.room_id))
- # missing keys or invalid json
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '{}')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '{"_name":"bob"}')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '{"nao')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '[{"_name":"bob"},{"_name":"jill"}]')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, 'text only')
- self.assertEquals(400, code, msg=str(response))
-
- (code, response) = yield self.mock_resource.trigger("PUT",
- path, '')
- self.assertEquals(400, code, msg=str(response))
-
- @defer.inlineCallbacks
- def test_rooms_messages_sent(self):
- path = "/rooms/%s/send/m.room.message/mid1" % (
- urllib.quote(self.room_id))
-
- content = '{"body":"test","msgtype":{"type":"a"}}'
- (code, response) = yield self.mock_resource.trigger("PUT", path, content)
- self.assertEquals(400, code, msg=str(response))
-
- # custom message types
- content = '{"body":"test","msgtype":"test.custom.text"}'
- (code, response) = yield self.mock_resource.trigger("PUT", path, content)
- self.assertEquals(200, code, msg=str(response))
-
-# (code, response) = yield self.mock_resource.trigger("GET", path, None)
-# self.assertEquals(200, code, msg=str(response))
-# self.assert_dict(json.loads(content), response)
-
- # m.text message type
- path = "/rooms/%s/send/m.room.message/mid2" % (
- urllib.quote(self.room_id))
- content = '{"body":"test2","msgtype":"m.text"}'
- (code, response) = yield self.mock_resource.trigger("PUT", path, content)
- self.assertEquals(200, code, msg=str(response))
-
-
-class RoomInitialSyncTestCase(RestTestCase):
- """ Tests /rooms/$room_id/initialSync. """
- user_id = "@sid1:red"
-
- @defer.inlineCallbacks
- def setUp(self):
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
- self.auth_user_id = self.user_id
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- db_pool = SQLiteMemoryDbPool()
- yield db_pool.prepare()
-
- hs = HomeServer(
- "red",
- db_pool=db_pool,
- http_client=None,
- replication_layer=Mock(),
- ratelimiter=NonCallableMock(spec_set=[
- "send_message",
- ]),
- config=self.mock_config,
- )
- self.ratelimiter = hs.get_ratelimiter()
- self.ratelimiter.send_message.return_value = (True, 0)
-
- hs.get_handlers().federation_handler = Mock()
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(self.auth_user_id),
- "admin": False,
- "device_id": None,
- }
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- def _insert_client_ip(*args, **kwargs):
- return defer.succeed(None)
- hs.get_datastore().insert_client_ip = _insert_client_ip
-
- synapse.rest.room.register_servlets(hs, self.mock_resource)
-
- # Since I'm getting my own presence I need to exist as far as presence
- # is concerned.
- hs.get_handlers().presence_handler.registered_user(
- hs.parse_userid(self.user_id)
- )
-
- # create the room
- self.room_id = yield self.create_room_as(self.user_id)
-
- @defer.inlineCallbacks
- def test_initial_sync(self):
- (code, response) = yield self.mock_resource.trigger_get(
- "/rooms/%s/initialSync" % self.room_id)
- self.assertEquals(200, code)
-
- self.assertEquals(self.room_id, response["room_id"])
- self.assertEquals("join", response["membership"])
-
- # Room state is easier to assert on if we unpack it into a dict
- state = {}
- for event in response["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 response)
- self.assertTrue("chunk" in response["messages"])
- self.assertTrue("end" in response["messages"])
-
- self.assertTrue("presence" in response)
-
- presence_by_user = {e["content"]["user_id"]: e
- for e in response["presence"]
- }
- self.assertTrue(self.user_id in presence_by_user)
- self.assertEquals("m.presence", presence_by_user[self.user_id]["type"])
diff --git a/tests/rest/test_typing.py b/tests/rest/test_typing.py
deleted file mode 100644
index 18138af1b5..0000000000
--- a/tests/rest/test_typing.py
+++ /dev/null
@@ -1,164 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2014 OpenMarket Ltd
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Tests REST events for /rooms paths."""
-
-# twisted imports
-from twisted.internet import defer
-
-import synapse.rest.room
-from synapse.server import HomeServer
-
-from ..utils import MockHttpResource, MockClock, SQLiteMemoryDbPool, MockKey
-from .utils import RestTestCase
-
-from mock import Mock, NonCallableMock
-
-
-PATH_PREFIX = "/_matrix/client/api/v1"
-
-
-class RoomTypingTestCase(RestTestCase):
- """ Tests /rooms/$room_id/typing/$user_id REST API. """
- user_id = "@sid:red"
-
- @defer.inlineCallbacks
- def setUp(self):
- self.clock = MockClock()
-
- self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
- self.auth_user_id = self.user_id
-
- self.mock_config = NonCallableMock()
- self.mock_config.signing_key = [MockKey()]
-
- db_pool = SQLiteMemoryDbPool()
- yield db_pool.prepare()
-
- hs = HomeServer(
- "red",
- clock=self.clock,
- db_pool=db_pool,
- http_client=None,
- replication_layer=Mock(),
- ratelimiter=NonCallableMock(spec_set=[
- "send_message",
- ]),
- config=self.mock_config,
- )
- self.hs = hs
-
- self.event_source = hs.get_event_sources().sources["typing"]
-
- self.ratelimiter = hs.get_ratelimiter()
- self.ratelimiter.send_message.return_value = (True, 0)
-
- hs.get_handlers().federation_handler = Mock()
-
- def _get_user_by_token(token=None):
- return {
- "user": hs.parse_userid(self.auth_user_id),
- "admin": False,
- "device_id": None,
- }
-
- hs.get_auth().get_user_by_token = _get_user_by_token
-
- def _insert_client_ip(*args, **kwargs):
- return defer.succeed(None)
- hs.get_datastore().insert_client_ip = _insert_client_ip
-
- def get_room_members(room_id):
- if room_id == self.room_id:
- return defer.succeed([hs.parse_userid(self.user_id)])
- else:
- return defer.succeed([])
-
- @defer.inlineCallbacks
- def fetch_room_distributions_into(room_id, localusers=None,
- remotedomains=None, ignore_user=None):
-
- members = yield get_room_members(room_id)
- for member in members:
- if ignore_user is not None and member == ignore_user:
- continue
-
- if hs.is_mine(member):
- if localusers is not None:
- localusers.add(member)
- else:
- if remotedomains is not None:
- remotedomains.add(member.domain)
- hs.get_handlers().room_member_handler.fetch_room_distributions_into = (
- fetch_room_distributions_into)
-
- synapse.rest.room.register_servlets(hs, self.mock_resource)
-
- self.room_id = yield self.create_room_as(self.user_id)
- # Need another user to make notifications actually work
- yield self.join(self.room_id, user="@jim:red")
-
- def tearDown(self):
- self.hs.get_handlers().typing_notification_handler.tearDown()
-
- @defer.inlineCallbacks
- def test_set_typing(self):
- (code, _) = yield self.mock_resource.trigger("PUT",
- "/rooms/%s/typing/%s" % (self.room_id, self.user_id),
- '{"typing": true, "timeout": 30000}'
- )
- self.assertEquals(200, code)
-
- self.assertEquals(self.event_source.get_current_key(), 1)
- self.assertEquals(
- self.event_source.get_new_events_for_user(self.user_id, 0, None)[0],
- [
- {"type": "m.typing",
- "room_id": self.room_id,
- "content": {
- "user_ids": [self.user_id],
- }},
- ]
- )
-
- @defer.inlineCallbacks
- def test_set_not_typing(self):
- (code, _) = yield self.mock_resource.trigger("PUT",
- "/rooms/%s/typing/%s" % (self.room_id, self.user_id),
- '{"typing": false}'
- )
- self.assertEquals(200, code)
-
- @defer.inlineCallbacks
- def test_typing_timeout(self):
- (code, _) = yield self.mock_resource.trigger("PUT",
- "/rooms/%s/typing/%s" % (self.room_id, self.user_id),
- '{"typing": true, "timeout": 30000}'
- )
- self.assertEquals(200, code)
-
- self.assertEquals(self.event_source.get_current_key(), 1)
-
- self.clock.advance_time(31);
-
- self.assertEquals(self.event_source.get_current_key(), 2)
-
- (code, _) = yield self.mock_resource.trigger("PUT",
- "/rooms/%s/typing/%s" % (self.room_id, self.user_id),
- '{"typing": true, "timeout": 30000}'
- )
- self.assertEquals(200, code)
-
- self.assertEquals(self.event_source.get_current_key(), 3)
diff --git a/tests/rest/utils.py b/tests/rest/utils.py
deleted file mode 100644
index 579441fb4a..0000000000
--- a/tests/rest/utils.py
+++ /dev/null
@@ -1,134 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2014 OpenMarket Ltd
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# twisted imports
-from twisted.internet import defer
-
-# trial imports
-from tests import unittest
-
-from synapse.api.constants import Membership
-
-import json
-import time
-
-
-class RestTestCase(unittest.TestCase):
- """Contains extra helper functions to quickly and clearly perform a given
- REST action, which isn't the focus of the test.
-
- This subclass assumes there are mock_resource and auth_user_id attributes.
- """
-
- def __init__(self, *args, **kwargs):
- super(RestTestCase, self).__init__(*args, **kwargs)
- self.mock_resource = None
- self.auth_user_id = None
-
- def mock_get_user_by_token(self, token=None):
- return self.auth_user_id
-
- @defer.inlineCallbacks
- def create_room_as(self, room_creator, is_public=True, tok=None):
- temp_id = self.auth_user_id
- self.auth_user_id = room_creator
- path = "/createRoom"
- content = "{}"
- if not is_public:
- content = '{"visibility":"private"}'
- if tok:
- path = path + "?access_token=%s" % tok
- (code, response) = yield self.mock_resource.trigger("POST", path, content)
- self.assertEquals(200, code, msg=str(response))
- self.auth_user_id = temp_id
- defer.returnValue(response["room_id"])
-
- @defer.inlineCallbacks
- def invite(self, room=None, src=None, targ=None, expect_code=200, tok=None):
- yield self.change_membership(room=room, src=src, targ=targ, tok=tok,
- membership=Membership.INVITE,
- expect_code=expect_code)
-
- @defer.inlineCallbacks
- def join(self, room=None, user=None, expect_code=200, tok=None):
- yield self.change_membership(room=room, src=user, targ=user, tok=tok,
- membership=Membership.JOIN,
- expect_code=expect_code)
-
- @defer.inlineCallbacks
- def leave(self, room=None, user=None, expect_code=200, tok=None):
- yield self.change_membership(room=room, src=user, targ=user, tok=tok,
- membership=Membership.LEAVE,
- expect_code=expect_code)
-
- @defer.inlineCallbacks
- def change_membership(self, room, src, targ, membership, tok=None,
- expect_code=200):
- temp_id = self.auth_user_id
- self.auth_user_id = src
-
- path = "/rooms/%s/state/m.room.member/%s" % (room, targ)
- if tok:
- path = path + "?access_token=%s" % tok
-
- data = {
- "membership": membership
- }
-
- (code, response) = yield self.mock_resource.trigger("PUT", path,
- json.dumps(data))
- self.assertEquals(expect_code, code, msg=str(response))
-
- self.auth_user_id = temp_id
-
- @defer.inlineCallbacks
- def register(self, user_id):
- (code, response) = yield self.mock_resource.trigger(
- "POST",
- "/register",
- json.dumps({
- "user": user_id,
- "password": "test",
- "type": "m.login.password"
- }))
- self.assertEquals(200, code)
- defer.returnValue(response)
-
- @defer.inlineCallbacks
- def send(self, room_id, body=None, txn_id=None, tok=None,
- expect_code=200):
- if txn_id is None:
- txn_id = "m%s" % (str(time.time()))
- if body is None:
- body = "body_text_here"
-
- path = "/rooms/%s/send/m.room.message/%s" % (room_id, txn_id)
- content = '{"msgtype":"m.text","body":"%s"}' % body
- if tok:
- path = path + "?access_token=%s" % tok
-
- (code, response) = yield self.mock_resource.trigger("PUT", path, content)
- self.assertEquals(expect_code, code, msg=str(response))
-
- def assert_dict(self, required, actual):
- """Does a partial assert of a dict.
-
- Args:
- required (dict): The keys and value which MUST be in 'actual'.
- actual (dict): The test result. Extra keys will not be checked.
- """
- for key in required:
- self.assertEquals(required[key], actual[key],
- msg="%s mismatch. %s" % (key, actual))
|
