2021-04-06 11:21:02 +00:00
|
|
|
# Copyright 2018-2021 The Matrix.org Foundation C.I.C.
|
2018-01-25 21:25:03 +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.
|
|
|
|
|
2021-04-06 11:21:02 +00:00
|
|
|
from tests.unittest import HomeserverTestCase, override_config
|
2018-01-25 21:25:03 +00:00
|
|
|
|
|
|
|
ALICE = "@alice:a"
|
|
|
|
BOB = "@bob:b"
|
|
|
|
BOBBY = "@bobby:a"
|
2020-12-17 13:42:30 +00:00
|
|
|
# The localpart isn't 'Bela' on purpose so we can test looking up display names.
|
|
|
|
BELA = "@somenickname:a"
|
2018-01-25 21:25:03 +00:00
|
|
|
|
|
|
|
|
2021-04-06 11:21:02 +00:00
|
|
|
class UserDirectoryStoreTestCase(HomeserverTestCase):
|
|
|
|
def prepare(self, reactor, clock, hs):
|
|
|
|
self.store = hs.get_datastore()
|
2018-01-25 21:25:03 +00:00
|
|
|
|
|
|
|
# alice and bob are both in !room_id. bobby is not but shares
|
|
|
|
# a homeserver with alice.
|
2021-04-06 11:21:02 +00:00
|
|
|
self.get_success(self.store.update_profile_in_user_dir(ALICE, "alice", None))
|
|
|
|
self.get_success(self.store.update_profile_in_user_dir(BOB, "bob", None))
|
|
|
|
self.get_success(self.store.update_profile_in_user_dir(BOBBY, "bobby", None))
|
|
|
|
self.get_success(self.store.update_profile_in_user_dir(BELA, "Bela", None))
|
|
|
|
self.get_success(self.store.add_users_in_public_rooms("!room:id", (ALICE, BOB)))
|
2018-01-25 21:25:03 +00:00
|
|
|
|
|
|
|
def test_search_user_dir(self):
|
|
|
|
# normally when alice searches the directory she should just find
|
|
|
|
# bob because bobby doesn't share a room with her.
|
2021-04-06 11:21:02 +00:00
|
|
|
r = self.get_success(self.store.search_user_dir(ALICE, "bob", 10))
|
2018-01-25 21:25:03 +00:00
|
|
|
self.assertFalse(r["limited"])
|
|
|
|
self.assertEqual(1, len(r["results"]))
|
2018-08-10 13:54:09 +00:00
|
|
|
self.assertDictEqual(
|
|
|
|
r["results"][0], {"user_id": BOB, "display_name": "bob", "avatar_url": None}
|
|
|
|
)
|
2018-01-25 21:25:03 +00:00
|
|
|
|
2021-04-06 11:21:02 +00:00
|
|
|
@override_config({"user_directory": {"search_all_users": True}})
|
2018-01-25 21:25:03 +00:00
|
|
|
def test_search_user_dir_all_users(self):
|
2021-04-06 11:21:02 +00:00
|
|
|
r = self.get_success(self.store.search_user_dir(ALICE, "bob", 10))
|
|
|
|
self.assertFalse(r["limited"])
|
|
|
|
self.assertEqual(2, len(r["results"]))
|
|
|
|
self.assertDictEqual(
|
|
|
|
r["results"][0],
|
|
|
|
{"user_id": BOB, "display_name": "bob", "avatar_url": None},
|
|
|
|
)
|
|
|
|
self.assertDictEqual(
|
|
|
|
r["results"][1],
|
|
|
|
{"user_id": BOBBY, "display_name": "bobby", "avatar_url": None},
|
|
|
|
)
|
2020-12-17 13:42:30 +00:00
|
|
|
|
2021-04-06 11:21:02 +00:00
|
|
|
@override_config({"user_directory": {"search_all_users": True}})
|
2020-12-17 13:42:30 +00:00
|
|
|
def test_search_user_dir_stop_words(self):
|
|
|
|
"""Tests that a user can look up another user by searching for the start if its
|
|
|
|
display name even if that name happens to be a common English word that would
|
|
|
|
usually be ignored in full text searches.
|
|
|
|
"""
|
2021-04-06 11:21:02 +00:00
|
|
|
r = self.get_success(self.store.search_user_dir(ALICE, "be", 10))
|
|
|
|
self.assertFalse(r["limited"])
|
|
|
|
self.assertEqual(1, len(r["results"]))
|
|
|
|
self.assertDictEqual(
|
|
|
|
r["results"][0],
|
|
|
|
{"user_id": BELA, "display_name": "Bela", "avatar_url": None},
|
|
|
|
)
|