synapse-old/tests/handlers/test_device.py

219 lines
7.2 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
# Copyright 2016 OpenMarket Ltd
2018-09-03 10:21:48 -06:00
# Copyright 2018 New Vector 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.
2016-07-22 07:52:53 -06:00
import synapse.api.errors
import synapse.handlers.device
import synapse.storage
2018-07-09 00:09:20 -06:00
2018-09-03 10:21:48 -06:00
from tests import unittest
2016-07-20 10:58:44 -06:00
user1 = "@boris:aaa"
user2 = "@theresa:bbb"
2016-07-21 06:15:15 -06:00
2018-09-03 10:21:48 -06:00
class DeviceTestCase(unittest.HomeserverTestCase):
def make_homeserver(self, reactor, clock):
hs = self.setup_test_homeserver("server", http_client=None)
self.handler = hs.get_device_handler()
self.store = hs.get_datastore()
2018-09-03 10:21:48 -06:00
return hs
def prepare(self, reactor, clock, hs):
# These tests assume that it starts 1000 seconds in.
self.reactor.advance(1000)
def test_device_is_created_if_doesnt_exist(self):
2018-09-03 10:21:48 -06:00
res = self.get_success(
self.handler.check_device_registered(
user_id="@boris:foo",
device_id="fco",
initial_device_display_name="display name",
)
)
self.assertEqual(res, "fco")
2018-09-03 10:21:48 -06:00
dev = self.get_success(self.handler.store.get_device("@boris:foo", "fco"))
self.assertEqual(dev["display_name"], "display name")
def test_device_is_preserved_if_exists(self):
2018-09-03 10:21:48 -06:00
res1 = self.get_success(
self.handler.check_device_registered(
user_id="@boris:foo",
device_id="fco",
initial_device_display_name="display name",
)
)
self.assertEqual(res1, "fco")
2018-09-03 10:21:48 -06:00
res2 = self.get_success(
self.handler.check_device_registered(
user_id="@boris:foo",
device_id="fco",
initial_device_display_name="new display name",
)
)
self.assertEqual(res2, "fco")
2018-09-03 10:21:48 -06:00
dev = self.get_success(self.handler.store.get_device("@boris:foo", "fco"))
self.assertEqual(dev["display_name"], "display name")
def test_device_id_is_made_up_if_unspecified(self):
2018-09-03 10:21:48 -06:00
device_id = self.get_success(
self.handler.check_device_registered(
user_id="@theresa:foo",
device_id=None,
initial_device_display_name="display",
)
)
2018-09-03 10:21:48 -06:00
dev = self.get_success(self.handler.store.get_device("@theresa:foo", device_id))
self.assertEqual(dev["display_name"], "display")
def test_get_devices_by_user(self):
2018-09-03 10:21:48 -06:00
self._record_users()
res = self.get_success(self.handler.get_devices_by_user(user1))
self.assertEqual(3, len(res))
2018-08-10 07:54:09 -06:00
device_map = {d["device_id"]: d for d in res}
self.assertDictContainsSubset(
{
"user_id": user1,
"device_id": "xyz",
"display_name": "display 0",
"last_seen_ip": None,
"last_seen_ts": None,
},
device_map["xyz"],
)
self.assertDictContainsSubset(
{
"user_id": user1,
"device_id": "fco",
"display_name": "display 1",
"last_seen_ip": "ip1",
"last_seen_ts": 1000000,
},
device_map["fco"],
)
self.assertDictContainsSubset(
{
"user_id": user1,
"device_id": "abc",
"display_name": "display 2",
"last_seen_ip": "ip3",
"last_seen_ts": 3000000,
},
device_map["abc"],
)
2016-07-20 10:58:44 -06:00
def test_get_device(self):
2018-09-03 10:21:48 -06:00
self._record_users()
2016-07-20 10:58:44 -06:00
2018-09-03 10:21:48 -06:00
res = self.get_success(self.handler.get_device(user1, "abc"))
2018-08-10 07:54:09 -06:00
self.assertDictContainsSubset(
{
"user_id": user1,
"device_id": "abc",
"display_name": "display 2",
"last_seen_ip": "ip3",
"last_seen_ts": 3000000,
},
res,
)
2016-07-20 10:58:44 -06:00
2016-07-22 07:52:53 -06:00
def test_delete_device(self):
2018-09-03 10:21:48 -06:00
self._record_users()
2016-07-22 07:52:53 -06:00
# delete the device
2018-09-03 10:21:48 -06:00
self.get_success(self.handler.delete_device(user1, "abc"))
2016-07-22 07:52:53 -06:00
# check the device was deleted
2018-09-03 10:21:48 -06:00
res = self.handler.get_device(user1, "abc")
self.pump()
self.assertIsInstance(
self.failureResultOf(res).value, synapse.api.errors.NotFoundError
)
2016-07-22 07:52:53 -06:00
# we'd like to check the access token was invalidated, but that's a
# bit of a PITA.
def test_update_device(self):
2018-09-03 10:21:48 -06:00
self._record_users()
update = {"display_name": "new display"}
2018-09-03 10:21:48 -06:00
self.get_success(self.handler.update_device(user1, "abc", update))
2018-09-03 10:21:48 -06:00
res = self.get_success(self.handler.get_device(user1, "abc"))
self.assertEqual(res["display_name"], "new display")
def test_update_device_too_long_display_name(self):
"""Update a device with a display name that is invalid (too long)."""
self._record_users()
# Request to update a device display name with a new value that is longer than allowed.
update = {
"display_name": "a"
* (synapse.handlers.device.MAX_DEVICE_DISPLAY_NAME_LEN + 1)
}
self.get_failure(
self.handler.update_device(user1, "abc", update),
synapse.api.errors.SynapseError,
)
# Ensure the display name was not updated.
res = self.get_success(self.handler.get_device(user1, "abc"))
self.assertEqual(res["display_name"], "display 2")
def test_update_unknown_device(self):
update = {"display_name": "new_display"}
2018-09-03 10:21:48 -06:00
res = self.handler.update_device("user_id", "unknown_device_id", update)
self.pump()
self.assertIsInstance(
self.failureResultOf(res).value, synapse.api.errors.NotFoundError
)
2016-07-22 07:52:53 -06:00
2016-07-20 10:58:44 -06:00
def _record_users(self):
# check this works for both devices which have a recorded client_ip,
# and those which don't.
2018-09-03 10:21:48 -06:00
self._record_user(user1, "xyz", "display 0")
self._record_user(user1, "fco", "display 1", "token1", "ip1")
self._record_user(user1, "abc", "display 2", "token2", "ip2")
self._record_user(user1, "abc", "display 2", "token3", "ip3")
self._record_user(user2, "def", "dispkay", "token4", "ip4")
2016-07-20 10:58:44 -06:00
2018-09-03 10:21:48 -06:00
self.reactor.advance(10000)
2016-07-20 10:58:44 -06:00
2018-08-10 07:54:09 -06:00
def _record_user(
self, user_id, device_id, display_name, access_token=None, ip=None
):
2018-09-03 10:21:48 -06:00
device_id = self.get_success(
self.handler.check_device_registered(
user_id=user_id,
device_id=device_id,
initial_device_display_name=display_name,
)
)
if ip is not None:
2018-09-03 10:21:48 -06:00
self.get_success(
self.store.insert_client_ip(
user_id, access_token, ip, "user_agent", device_id
)
2018-08-10 07:54:09 -06:00
)
2018-09-03 10:21:48 -06:00
self.reactor.advance(1000)