2014-08-12 14:10:52 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-07 04:26:29 +00:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2014-08-13 02:32:18 +00:00
|
|
|
#
|
|
|
|
# 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 14:10:52 +00:00
|
|
|
"""Tests REST events for /profile paths."""
|
2016-01-11 15:29:57 +00:00
|
|
|
from mock import Mock
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2016-07-26 15:46:53 +00:00
|
|
|
from twisted.internet import defer
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2016-07-26 15:46:53 +00:00
|
|
|
import synapse.types
|
2018-07-09 06:09:20 +00:00
|
|
|
from synapse.api.errors import AuthError, SynapseError
|
2015-01-23 10:37:38 +00:00
|
|
|
from synapse.rest.client.v1 import profile
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2016-07-26 15:46:53 +00:00
|
|
|
from tests import unittest
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2016-07-26 15:46:53 +00:00
|
|
|
from ....utils import MockHttpResource, setup_test_homeserver
|
2015-01-23 10:37:38 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
myid = "@1234ABCD:test"
|
2014-08-31 13:51:37 +00:00
|
|
|
PATH_PREFIX = "/_matrix/client/api/v1"
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2014-09-12 17:24:53 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
class ProfileTestCase(unittest.TestCase):
|
|
|
|
""" Tests profile management. """
|
|
|
|
|
2015-02-11 11:37:30 +00:00
|
|
|
@defer.inlineCallbacks
|
2014-08-12 14:10:52 +00:00
|
|
|
def setUp(self):
|
2014-08-18 13:03:07 +00:00
|
|
|
self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
|
2014-08-12 14:10:52 +00:00
|
|
|
self.mock_handler = Mock(spec=[
|
|
|
|
"get_displayname",
|
|
|
|
"set_displayname",
|
|
|
|
"get_avatar_url",
|
|
|
|
"set_avatar_url",
|
|
|
|
])
|
|
|
|
|
2015-02-11 11:37:30 +00:00
|
|
|
hs = yield setup_test_homeserver(
|
|
|
|
"test",
|
2014-08-12 14:10:52 +00:00
|
|
|
http_client=None,
|
2014-08-18 13:03:07 +00:00
|
|
|
resource_for_client=self.mock_resource,
|
2014-08-12 14:10:52 +00:00
|
|
|
federation=Mock(),
|
2018-03-13 13:26:52 +00:00
|
|
|
federation_client=Mock(),
|
2017-08-25 13:34:56 +00:00
|
|
|
profile_handler=self.mock_handler
|
2014-08-12 14:10:52 +00:00
|
|
|
)
|
|
|
|
|
2015-11-04 17:29:07 +00:00
|
|
|
def _get_user_by_req(request=None, allow_guest=False):
|
2016-07-26 15:46:53 +00:00
|
|
|
return synapse.types.create_requester(myid)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2018-04-30 19:58:30 +00:00
|
|
|
hs.get_auth().get_user_by_req = _get_user_by_req
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2015-01-23 10:37:38 +00:00
|
|
|
profile.register_servlets(hs, self.mock_resource)
|
2014-08-12 14:10:52 +00: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 15:34:38 +00:00
|
|
|
(code, response) = yield self.mock_resource.trigger(
|
|
|
|
"GET", "/profile/%s/displayname" % (myid), None
|
|
|
|
)
|
2014-08-12 14:10:52 +00: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 15:34:38 +00:00
|
|
|
(code, response) = yield self.mock_resource.trigger(
|
|
|
|
"PUT",
|
|
|
|
"/profile/%s/displayname" % (myid),
|
2018-08-09 02:22:01 +00:00
|
|
|
b'{"displayname": "Frank Jr."}'
|
2016-02-19 15:34:38 +00:00
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
self.assertEquals(200, code)
|
|
|
|
self.assertEquals(mocked_set.call_args[0][0].localpart, "1234ABCD")
|
2016-03-03 16:43:42 +00:00
|
|
|
self.assertEquals(mocked_set.call_args[0][1].user.localpart, "1234ABCD")
|
2014-08-12 14:10:52 +00: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 15:34:38 +00:00
|
|
|
(code, response) = yield self.mock_resource.trigger(
|
2016-03-11 16:41:03 +00:00
|
|
|
"PUT", "/profile/%s/displayname" % ("@4567:test"),
|
2018-08-09 02:22:01 +00:00
|
|
|
b'{"displayname": "Frank Jr."}'
|
2016-02-19 15:34:38 +00:00
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2016-02-19 15:34:38 +00:00
|
|
|
self.assertTrue(
|
|
|
|
400 <= code < 499,
|
|
|
|
msg="code %d is in the 4xx range" % (code)
|
|
|
|
)
|
2014-08-12 14:10:52 +00: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 15:34:38 +00:00
|
|
|
(code, response) = yield self.mock_resource.trigger(
|
|
|
|
"GET", "/profile/%s/displayname" % ("@opaque:elsewhere"), None
|
|
|
|
)
|
2014-08-12 14:10:52 +00: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 15:34:38 +00:00
|
|
|
(code, response) = yield self.mock_resource.trigger(
|
2016-03-11 16:41:03 +00:00
|
|
|
"PUT", "/profile/%s/displayname" % ("@opaque:elsewhere"),
|
2018-08-09 02:22:01 +00:00
|
|
|
b'{"displayname":"bob"}'
|
2016-02-19 15:34:38 +00:00
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2016-02-19 15:34:38 +00:00
|
|
|
self.assertTrue(
|
|
|
|
400 <= code <= 499,
|
|
|
|
msg="code %d is in the 4xx range" % (code)
|
|
|
|
)
|
2014-08-12 14:10:52 +00: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 15:34:38 +00:00
|
|
|
(code, response) = yield self.mock_resource.trigger(
|
|
|
|
"GET", "/profile/%s/avatar_url" % (myid), None
|
|
|
|
)
|
2014-08-12 14:10:52 +00: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 15:34:38 +00:00
|
|
|
(code, response) = yield self.mock_resource.trigger(
|
|
|
|
"PUT",
|
|
|
|
"/profile/%s/avatar_url" % (myid),
|
2018-08-09 02:22:01 +00:00
|
|
|
b'{"avatar_url": "http://my.server/pic.gif"}'
|
2016-02-19 15:34:38 +00:00
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
self.assertEquals(200, code)
|
|
|
|
self.assertEquals(mocked_set.call_args[0][0].localpart, "1234ABCD")
|
2016-03-03 16:43:42 +00:00
|
|
|
self.assertEquals(mocked_set.call_args[0][1].user.localpart, "1234ABCD")
|
2016-02-19 15:34:38 +00:00
|
|
|
self.assertEquals(mocked_set.call_args[0][2], "http://my.server/pic.gif")
|