286 lines
8.4 KiB
Python
286 lines
8.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
# 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.
|
|
|
|
|
|
from mock import Mock
|
|
|
|
from twisted.internet import defer
|
|
|
|
import synapse.types
|
|
from synapse.api.errors import AuthError, SynapseError
|
|
from synapse.types import UserID
|
|
|
|
from tests import unittest
|
|
from tests.test_utils import make_awaitable
|
|
from tests.utils import setup_test_homeserver
|
|
|
|
|
|
class ProfileTestCase(unittest.TestCase):
|
|
""" Tests profile management. """
|
|
|
|
@defer.inlineCallbacks
|
|
def setUp(self):
|
|
self.mock_federation = Mock()
|
|
self.mock_registry = Mock()
|
|
|
|
self.query_handlers = {}
|
|
|
|
def register_query_handler(query_type, handler):
|
|
self.query_handlers[query_type] = handler
|
|
|
|
self.mock_registry.register_query_handler = register_query_handler
|
|
|
|
hs = yield setup_test_homeserver(
|
|
self.addCleanup,
|
|
federation_client=self.mock_federation,
|
|
federation_server=Mock(),
|
|
federation_registry=self.mock_registry,
|
|
)
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.frank = UserID.from_string("@1234ABCD:test")
|
|
self.bob = UserID.from_string("@4567:test")
|
|
self.alice = UserID.from_string("@alice:remote")
|
|
|
|
yield defer.ensureDeferred(self.store.create_profile(self.frank.localpart))
|
|
|
|
self.handler = hs.get_profile_handler()
|
|
self.hs = hs
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_my_name(self):
|
|
yield defer.ensureDeferred(
|
|
self.store.set_profile_displayname(self.frank.localpart, "Frank")
|
|
)
|
|
|
|
displayname = yield defer.ensureDeferred(
|
|
self.handler.get_displayname(self.frank)
|
|
)
|
|
|
|
self.assertEquals("Frank", displayname)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_set_my_name(self):
|
|
yield defer.ensureDeferred(
|
|
self.handler.set_displayname(
|
|
self.frank, synapse.types.create_requester(self.frank), "Frank Jr."
|
|
)
|
|
)
|
|
|
|
self.assertEquals(
|
|
(
|
|
yield defer.ensureDeferred(
|
|
self.store.get_profile_displayname(self.frank.localpart)
|
|
)
|
|
),
|
|
"Frank Jr.",
|
|
)
|
|
|
|
# Set displayname again
|
|
yield defer.ensureDeferred(
|
|
self.handler.set_displayname(
|
|
self.frank, synapse.types.create_requester(self.frank), "Frank"
|
|
)
|
|
)
|
|
|
|
self.assertEquals(
|
|
(
|
|
yield defer.ensureDeferred(
|
|
self.store.get_profile_displayname(self.frank.localpart)
|
|
)
|
|
),
|
|
"Frank",
|
|
)
|
|
|
|
# Set displayname to an empty string
|
|
yield defer.ensureDeferred(
|
|
self.handler.set_displayname(
|
|
self.frank, synapse.types.create_requester(self.frank), ""
|
|
)
|
|
)
|
|
|
|
self.assertIsNone(
|
|
(
|
|
yield defer.ensureDeferred(
|
|
self.store.get_profile_displayname(self.frank.localpart)
|
|
)
|
|
)
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_set_my_name_if_disabled(self):
|
|
self.hs.config.enable_set_displayname = False
|
|
|
|
# Setting displayname for the first time is allowed
|
|
yield defer.ensureDeferred(
|
|
self.store.set_profile_displayname(self.frank.localpart, "Frank")
|
|
)
|
|
|
|
self.assertEquals(
|
|
(
|
|
yield defer.ensureDeferred(
|
|
self.store.get_profile_displayname(self.frank.localpart)
|
|
)
|
|
),
|
|
"Frank",
|
|
)
|
|
|
|
# Setting displayname a second time is forbidden
|
|
d = defer.ensureDeferred(
|
|
self.handler.set_displayname(
|
|
self.frank, synapse.types.create_requester(self.frank), "Frank Jr."
|
|
)
|
|
)
|
|
|
|
yield self.assertFailure(d, SynapseError)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_set_my_name_noauth(self):
|
|
d = defer.ensureDeferred(
|
|
self.handler.set_displayname(
|
|
self.frank, synapse.types.create_requester(self.bob), "Frank Jr."
|
|
)
|
|
)
|
|
|
|
yield self.assertFailure(d, AuthError)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_other_name(self):
|
|
self.mock_federation.make_query.return_value = make_awaitable(
|
|
{"displayname": "Alice"}
|
|
)
|
|
|
|
displayname = yield defer.ensureDeferred(
|
|
self.handler.get_displayname(self.alice)
|
|
)
|
|
|
|
self.assertEquals(displayname, "Alice")
|
|
self.mock_federation.make_query.assert_called_with(
|
|
destination="remote",
|
|
query_type="profile",
|
|
args={"user_id": "@alice:remote", "field": "displayname"},
|
|
ignore_backoff=True,
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_incoming_fed_query(self):
|
|
yield defer.ensureDeferred(self.store.create_profile("caroline"))
|
|
yield defer.ensureDeferred(
|
|
self.store.set_profile_displayname("caroline", "Caroline")
|
|
)
|
|
|
|
response = yield defer.ensureDeferred(
|
|
self.query_handlers["profile"](
|
|
{"user_id": "@caroline:test", "field": "displayname"}
|
|
)
|
|
)
|
|
|
|
self.assertEquals({"displayname": "Caroline"}, response)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_my_avatar(self):
|
|
yield defer.ensureDeferred(
|
|
self.store.set_profile_avatar_url(
|
|
self.frank.localpart, "http://my.server/me.png"
|
|
)
|
|
)
|
|
avatar_url = yield defer.ensureDeferred(self.handler.get_avatar_url(self.frank))
|
|
|
|
self.assertEquals("http://my.server/me.png", avatar_url)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_set_my_avatar(self):
|
|
yield defer.ensureDeferred(
|
|
self.handler.set_avatar_url(
|
|
self.frank,
|
|
synapse.types.create_requester(self.frank),
|
|
"http://my.server/pic.gif",
|
|
)
|
|
)
|
|
|
|
self.assertEquals(
|
|
(
|
|
yield defer.ensureDeferred(
|
|
self.store.get_profile_avatar_url(self.frank.localpart)
|
|
)
|
|
),
|
|
"http://my.server/pic.gif",
|
|
)
|
|
|
|
# Set avatar again
|
|
yield defer.ensureDeferred(
|
|
self.handler.set_avatar_url(
|
|
self.frank,
|
|
synapse.types.create_requester(self.frank),
|
|
"http://my.server/me.png",
|
|
)
|
|
)
|
|
|
|
self.assertEquals(
|
|
(
|
|
yield defer.ensureDeferred(
|
|
self.store.get_profile_avatar_url(self.frank.localpart)
|
|
)
|
|
),
|
|
"http://my.server/me.png",
|
|
)
|
|
|
|
# Set avatar to an empty string
|
|
yield defer.ensureDeferred(
|
|
self.handler.set_avatar_url(
|
|
self.frank, synapse.types.create_requester(self.frank), "",
|
|
)
|
|
)
|
|
|
|
self.assertIsNone(
|
|
(
|
|
yield defer.ensureDeferred(
|
|
self.store.get_profile_avatar_url(self.frank.localpart)
|
|
)
|
|
),
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_set_my_avatar_if_disabled(self):
|
|
self.hs.config.enable_set_avatar_url = False
|
|
|
|
# Setting displayname for the first time is allowed
|
|
yield defer.ensureDeferred(
|
|
self.store.set_profile_avatar_url(
|
|
self.frank.localpart, "http://my.server/me.png"
|
|
)
|
|
)
|
|
|
|
self.assertEquals(
|
|
(
|
|
yield defer.ensureDeferred(
|
|
self.store.get_profile_avatar_url(self.frank.localpart)
|
|
)
|
|
),
|
|
"http://my.server/me.png",
|
|
)
|
|
|
|
# Set avatar a second time is forbidden
|
|
d = defer.ensureDeferred(
|
|
self.handler.set_avatar_url(
|
|
self.frank,
|
|
synapse.types.create_requester(self.frank),
|
|
"http://my.server/pic.gif",
|
|
)
|
|
)
|
|
|
|
yield self.assertFailure(d, SynapseError)
|