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

162 lines
5.4 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."""
from tests import unittest
2014-08-12 16:10:52 +02:00
from twisted.internet import defer
from mock import Mock
2014-08-12 16:10:52 +02:00
from ....utils import MockHttpResource, setup_test_homeserver
2014-08-12 16:10:52 +02:00
from synapse.api.errors import SynapseError, AuthError
from synapse.types import Requester, UserID
2014-08-12 16:10:52 +02:00
from synapse.rest.client.v1 import profile
2014-08-12 16:10:52 +02:00
myid = "@1234ABCD:test"
PATH_PREFIX = "/_matrix/client/api/v1"
2014-08-12 16:10:52 +02:00
2014-08-12 16:10:52 +02:00
class ProfileTestCase(unittest.TestCase):
""" Tests profile management. """
@defer.inlineCallbacks
2014-08-12 16:10:52 +02:00
def setUp(self):
self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
2014-08-12 16:10:52 +02:00
self.mock_handler = Mock(spec=[
"get_displayname",
"set_displayname",
"get_avatar_url",
"set_avatar_url",
])
hs = yield setup_test_homeserver(
"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(),
replication_layer=Mock(),
)
def _get_user_by_req(request=None, allow_guest=False):
return Requester(UserID.from_string(myid), "", False)
2014-08-12 16:10:52 +02:00
2015-03-24 19:56:51 +01:00
hs.get_v1auth().get_user_by_req = _get_user_by_req
2014-08-12 16:10:52 +02:00
hs.get_handlers().profile_handler = self.mock_handler
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(
"PUT",
"/profile/%s/displayname" % (myid),
'{"displayname": "Frank Jr."}'
)
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(
"PUT", "/profile/%s/displayname" % ("@4567:test"),
'{"displayname": "Frank Jr."}'
2016-02-19 16:34:38 +01:00
)
2014-08-12 16:10:52 +02:00
2016-02-19 16:34:38 +01: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(
"PUT", "/profile/%s/displayname" % ("@opaque:elsewhere"),
'{"displayname":"bob"}'
2016-02-19 16:34:38 +01:00
)
2014-08-12 16:10:52 +02:00
2016-02-19 16:34:38 +01: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),
'{"avatar_url": "http://my.server/pic.gif"}'
)
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")