MatrixSynapse/tests/rest/client/v1/test_profile.py

338 lines
11 KiB
Python
Raw Normal View History

2014-08-12 16:10:52 +02:00
# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
2014-08-12 16:10:52 +02:00
"""Tests REST events for /profile paths."""
2019-06-01 12:13:49 +02:00
import json
from mock import Mock
2018-07-09 08:09:20 +02:00
from twisted.internet import defer
2014-08-12 16:10:52 +02:00
import synapse.types
2018-07-09 08:09:20 +02:00
from synapse.api.errors import AuthError, SynapseError
2019-05-08 22:57:03 +02:00
from synapse.rest import admin
from synapse.rest.client.v1 import login, profile, room
2018-07-09 08:09:20 +02:00
from tests import unittest
2018-07-09 08:09:20 +02:00
from ....utils import MockHttpResource, setup_test_homeserver
2014-08-12 16:10:52 +02:00
myid = "@1234ABCD:test"
PATH_PREFIX = "/_matrix/client/r0"
2014-08-12 16:10:52 +02:00
2019-06-01 12:13:49 +02:00
class MockHandlerProfileTestCase(unittest.TestCase):
""" Tests rest layer of profile management.
Todo: move these into ProfileTestCase
"""
2014-08-12 16:10:52 +02:00
@defer.inlineCallbacks
2014-08-12 16:10:52 +02:00
def setUp(self):
self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
2018-08-10 15:54:09 +02:00
self.mock_handler = Mock(
spec=[
"get_displayname",
"set_displayname",
"get_avatar_url",
"set_avatar_url",
"check_profile_query_allowed",
2018-08-10 15:54:09 +02:00
]
)
2014-08-12 16:10:52 +02:00
hs = yield setup_test_homeserver(
2018-08-13 08:47:46 +02:00
self.addCleanup,
"test",
2014-08-12 16:10:52 +02:00
http_client=None,
resource_for_client=self.mock_resource,
2014-08-12 16:10:52 +02:00
federation=Mock(),
federation_client=Mock(),
2018-08-10 15:54:09 +02:00
profile_handler=self.mock_handler,
2014-08-12 16:10:52 +02:00
)
def _get_user_by_req(request=None, allow_guest=False):
return synapse.types.create_requester(myid)
2014-08-12 16:10:52 +02:00
hs.get_auth().get_user_by_req = _get_user_by_req
2014-08-12 16:10:52 +02:00
profile.register_servlets(hs, self.mock_resource)
2014-08-12 16:10:52 +02:00
@defer.inlineCallbacks
def test_get_my_name(self):
mocked_get = self.mock_handler.get_displayname
mocked_get.return_value = defer.succeed("Frank")
2016-02-19 16:34:38 +01:00
(code, response) = yield self.mock_resource.trigger(
"GET", "/profile/%s/displayname" % (myid), None
)
2014-08-12 16:10:52 +02:00
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(())
2016-02-19 16:34:38 +01:00
(code, response) = yield self.mock_resource.trigger(
2018-08-10 15:54:09 +02:00
"PUT", "/profile/%s/displayname" % (myid), b'{"displayname": "Frank Jr."}'
2016-02-19 16:34:38 +01:00
)
2014-08-12 16:10:52 +02:00
self.assertEquals(200, code)
self.assertEquals(mocked_set.call_args[0][0].localpart, "1234ABCD")
self.assertEquals(mocked_set.call_args[0][1].user.localpart, "1234ABCD")
2014-08-12 16:10:52 +02:00
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")
2016-02-19 16:34:38 +01:00
(code, response) = yield self.mock_resource.trigger(
2018-08-10 15:54:09 +02:00
"PUT",
"/profile/%s/displayname" % ("@4567:test"),
b'{"displayname": "Frank Jr."}',
2016-02-19 16:34:38 +01:00
)
2014-08-12 16:10:52 +02:00
2018-08-10 15:54:09 +02:00
self.assertTrue(400 <= code < 499, msg="code %d is in the 4xx range" % (code))
2014-08-12 16:10:52 +02:00
@defer.inlineCallbacks
def test_get_other_name(self):
mocked_get = self.mock_handler.get_displayname
mocked_get.return_value = defer.succeed("Bob")
2016-02-19 16:34:38 +01:00
(code, response) = yield self.mock_resource.trigger(
"GET", "/profile/%s/displayname" % ("@opaque:elsewhere"), None
)
2014-08-12 16:10:52 +02:00
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")
2016-02-19 16:34:38 +01:00
(code, response) = yield self.mock_resource.trigger(
2018-08-10 15:54:09 +02:00
"PUT",
"/profile/%s/displayname" % ("@opaque:elsewhere"),
b'{"displayname":"bob"}',
2016-02-19 16:34:38 +01:00
)
2014-08-12 16:10:52 +02:00
2018-08-10 15:54:09 +02:00
self.assertTrue(400 <= code <= 499, msg="code %d is in the 4xx range" % (code))
2014-08-12 16:10:52 +02:00
@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")
2016-02-19 16:34:38 +01:00
(code, response) = yield self.mock_resource.trigger(
"GET", "/profile/%s/avatar_url" % (myid), None
)
2014-08-12 16:10:52 +02:00
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(())
2016-02-19 16:34:38 +01:00
(code, response) = yield self.mock_resource.trigger(
"PUT",
"/profile/%s/avatar_url" % (myid),
2018-08-10 15:54:09 +02:00
b'{"avatar_url": "http://my.server/pic.gif"}',
2016-02-19 16:34:38 +01:00
)
2014-08-12 16:10:52 +02:00
self.assertEquals(200, code)
self.assertEquals(mocked_set.call_args[0][0].localpart, "1234ABCD")
self.assertEquals(mocked_set.call_args[0][1].user.localpart, "1234ABCD")
2016-02-19 16:34:38 +01:00
self.assertEquals(mocked_set.call_args[0][2], "http://my.server/pic.gif")
2019-06-01 12:13:49 +02:00
class ProfileTestCase(unittest.HomeserverTestCase):
servlets = [
admin.register_servlets_for_client_rest_resource,
login.register_servlets,
profile.register_servlets,
]
def make_homeserver(self, reactor, clock):
self.hs = self.setup_test_homeserver()
return self.hs
def prepare(self, reactor, clock, hs):
self.owner = self.register_user("owner", "pass")
self.owner_tok = self.login("owner", "pass")
def test_set_displayname(self):
request, channel = self.make_request(
"PUT",
2019-06-20 11:32:02 +02:00
"/profile/%s/displayname" % (self.owner,),
2019-06-01 12:13:49 +02:00
content=json.dumps({"displayname": "test"}),
access_token=self.owner_tok,
)
self.render(request)
self.assertEqual(channel.code, 200, channel.result)
res = self.get_displayname()
self.assertEqual(res, "test")
def test_set_displayname_too_long(self):
"""Attempts to set a stupid displayname should get a 400"""
request, channel = self.make_request(
"PUT",
2019-06-20 11:32:02 +02:00
"/profile/%s/displayname" % (self.owner,),
2019-06-01 12:13:49 +02:00
content=json.dumps({"displayname": "test" * 100}),
access_token=self.owner_tok,
)
self.render(request)
self.assertEqual(channel.code, 400, channel.result)
res = self.get_displayname()
self.assertEqual(res, "owner")
def get_displayname(self):
request, channel = self.make_request(
2019-06-20 11:32:02 +02:00
"GET", "/profile/%s/displayname" % (self.owner,)
2019-06-01 12:13:49 +02:00
)
self.render(request)
self.assertEqual(channel.code, 200, channel.result)
return channel.json_body["displayname"]
class ProfilesRestrictedTestCase(unittest.HomeserverTestCase):
servlets = [
2019-05-08 22:57:03 +02:00
admin.register_servlets_for_client_rest_resource,
login.register_servlets,
profile.register_servlets,
room.register_servlets,
]
def make_homeserver(self, reactor, clock):
config = self.default_config()
config["require_auth_for_profile_requests"] = True
self.hs = self.setup_test_homeserver(config=config)
return self.hs
def prepare(self, reactor, clock, hs):
# User owning the requested profile.
self.owner = self.register_user("owner", "pass")
self.owner_tok = self.login("owner", "pass")
self.profile_url = "/profile/%s" % (self.owner)
# User requesting the profile.
self.requester = self.register_user("requester", "pass")
self.requester_tok = self.login("requester", "pass")
self.room_id = self.helper.create_room_as(self.owner, tok=self.owner_tok)
def test_no_auth(self):
self.try_fetch_profile(401)
def test_not_in_shared_room(self):
self.ensure_requester_left_room()
self.try_fetch_profile(403, access_token=self.requester_tok)
def test_in_shared_room(self):
self.ensure_requester_left_room()
2019-05-10 07:12:11 +02:00
self.helper.join(room=self.room_id, user=self.requester, tok=self.requester_tok)
self.try_fetch_profile(200, self.requester_tok)
def try_fetch_profile(self, expected_code, access_token=None):
2019-05-10 07:12:11 +02:00
self.request_profile(expected_code, access_token=access_token)
self.request_profile(
2019-05-10 07:12:11 +02:00
expected_code, url_suffix="/displayname", access_token=access_token
)
self.request_profile(
2019-05-10 07:12:11 +02:00
expected_code, url_suffix="/avatar_url", access_token=access_token
)
def request_profile(self, expected_code, url_suffix="", access_token=None):
request, channel = self.make_request(
2019-05-10 07:12:11 +02:00
"GET", self.profile_url + url_suffix, access_token=access_token
)
self.render(request)
self.assertEqual(channel.code, expected_code, channel.result)
def ensure_requester_left_room(self):
try:
self.helper.leave(
2019-05-10 07:12:11 +02:00
room=self.room_id, user=self.requester, tok=self.requester_tok
)
except AssertionError:
# We don't care whether the leave request didn't return a 200 (e.g.
# if the user isn't already in the room), because we only want to
# make sure the user isn't in the room.
pass
2019-07-08 18:41:16 +02:00
class OwnProfileUnrestrictedTestCase(unittest.HomeserverTestCase):
servlets = [
admin.register_servlets_for_client_rest_resource,
login.register_servlets,
profile.register_servlets,
]
def make_homeserver(self, reactor, clock):
config = self.default_config()
config["require_auth_for_profile_requests"] = True
self.hs = self.setup_test_homeserver(config=config)
return self.hs
def prepare(self, reactor, clock, hs):
# User requesting the profile.
self.requester = self.register_user("requester", "pass")
self.requester_tok = self.login("requester", "pass")
def test_can_lookup_own_profile(self):
"""Tests that a user can lookup their own profile without having to be in a room
if 'require_auth_for_profile_requests' is set to true in the server's config.
"""
request, channel = self.make_request(
"GET", "/profile/" + self.requester, access_token=self.requester_tok
)
self.render(request)
self.assertEqual(channel.code, 200, channel.result)
request, channel = self.make_request(
"GET",
"/profile/" + self.requester + "/displayname",
2019-07-08 18:44:20 +02:00
access_token=self.requester_tok,
2019-07-08 18:41:16 +02:00
)
self.render(request)
self.assertEqual(channel.code, 200, channel.result)
request, channel = self.make_request(
"GET",
"/profile/" + self.requester + "/avatar_url",
2019-07-08 18:44:20 +02:00
access_token=self.requester_tok,
2019-07-08 18:41:16 +02:00
)
self.render(request)
self.assertEqual(channel.code, 200, channel.result)