Newer
Older
Matthew Hodgson
committed
#
# 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, NonCallableMock
from synapse.api.errors import AuthError, SynapseError
from synapse.handlers.profile import MasterProfileHandler
from synapse.types import UserID
from tests.utils import setup_test_homeserver
Paul "LeoNerd" Evans
committed
class ProfileHandlers(object):
def __init__(self, hs):
self.profile_handler = MasterProfileHandler(hs)
class ProfileTestCase(unittest.TestCase):
""" Tests profile management. """
Paul "LeoNerd" Evans
committed
@defer.inlineCallbacks
Paul "LeoNerd" Evans
committed
self.query_handlers = {}
Paul "LeoNerd" Evans
committed
def register_query_handler(query_type, handler):
self.query_handlers[query_type] = handler
self.mock_registry.register_query_handler = register_query_handler
Paul "LeoNerd" Evans
committed
hs = yield setup_test_homeserver(
http_client=None,
handlers=None,
resource_for_federation=Mock(),
federation_client=self.mock_federation,
ratelimiter=NonCallableMock(spec_set=["can_do_action"]),
self.ratelimiter = hs.get_ratelimiter()
self.ratelimiter.can_do_action.return_value = (True, 0)
Paul "LeoNerd" Evans
committed
self.store = hs.get_datastore()
self.frank = UserID.from_string("@1234ABCD:test")
self.alice = UserID.from_string("@alice:remote")
Paul "LeoNerd" Evans
committed
yield self.store.create_profile(self.frank.localpart)
self.handler = hs.get_profile_handler()
self.hs = hs
Erik Johnston
committed
@defer.inlineCallbacks
def test_get_my_name(self):
yield self.store.set_profile_displayname(self.frank.localpart, "Frank")
displayname = yield self.handler.get_displayname(self.frank)
self.assertEquals("Frank", displayname)
@defer.inlineCallbacks
def test_set_my_name(self):
yield self.handler.set_displayname(
Paul "LeoNerd" Evans
committed
self.assertEquals(
(yield self.store.get_profile_displayname(self.frank.localpart)),
Erik Johnston
committed
)
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# Set displayname again
yield self.handler.set_displayname(
self.frank, synapse.types.create_requester(self.frank), "Frank"
)
self.assertEquals(
(yield self.store.get_profile_displayname(self.frank.localpart)), "Frank",
)
@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 self.store.set_profile_displayname(self.frank.localpart, "Frank")
self.assertEquals(
(yield self.store.get_profile_displayname(self.frank.localpart)), "Frank",
)
# Setting displayname a second time is forbidden
d = 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 = self.handler.set_displayname(
yield self.assertFailure(d, AuthError)
@defer.inlineCallbacks
def test_get_other_name(self):
Paul "LeoNerd" Evans
committed
self.mock_federation.make_query.return_value = defer.succeed(
{"displayname": "Alice"}
)
displayname = yield self.handler.get_displayname(self.alice)
self.assertEquals(displayname, "Alice")
Paul "LeoNerd" Evans
committed
self.mock_federation.make_query.assert_called_with(
Paul "LeoNerd" Evans
committed
query_type="profile",
args={"user_id": "@alice:remote", "field": "displayname"},
ignore_backoff=True,
Paul "LeoNerd" Evans
committed
)
@defer.inlineCallbacks
def test_incoming_fed_query(self):
Paul "LeoNerd" Evans
committed
yield self.store.create_profile("caroline")
yield self.store.set_profile_displayname("caroline", "Caroline")
Paul "LeoNerd" Evans
committed
response = yield self.query_handlers["profile"](
{"user_id": "@caroline:test", "field": "displayname"}
Paul "LeoNerd" Evans
committed
self.assertEquals({"displayname": "Caroline"}, response)
@defer.inlineCallbacks
def test_get_my_avatar(self):
Paul "LeoNerd" Evans
committed
yield self.store.set_profile_avatar_url(
self.frank.localpart, "http://my.server/me.png"
)
avatar_url = yield self.handler.get_avatar_url(self.frank)
self.assertEquals("http://my.server/me.png", avatar_url)
@defer.inlineCallbacks
def test_set_my_avatar(self):
self.frank,
synapse.types.create_requester(self.frank),
"http://my.server/pic.gif",
Paul "LeoNerd" Evans
committed
self.assertEquals(
(yield self.store.get_profile_avatar_url(self.frank.localpart)),
Erik Johnston
committed
)
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# Set avatar again
yield self.handler.set_avatar_url(
self.frank,
synapse.types.create_requester(self.frank),
"http://my.server/me.png",
)
self.assertEquals(
(yield self.store.get_profile_avatar_url(self.frank.localpart)),
"http://my.server/me.png",
)
@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 self.store.set_profile_avatar_url(
self.frank.localpart, "http://my.server/me.png"
)
self.assertEquals(
(yield self.store.get_profile_avatar_url(self.frank.localpart)),
"http://my.server/me.png",
)
# Set avatar a second time is forbidden
d = self.handler.set_avatar_url(
self.frank,
synapse.types.create_requester(self.frank),
"http://my.server/pic.gif",
)
yield self.assertFailure(d, SynapseError)