142 lines
4.9 KiB
Python
142 lines
4.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 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 twisted.internet import defer
|
|
|
|
import synapse.api.errors
|
|
|
|
import tests.unittest
|
|
import tests.utils
|
|
|
|
|
|
class DeviceStoreTestCase(tests.unittest.TestCase):
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
self.store = None # type: synapse.storage.DataStore
|
|
|
|
@defer.inlineCallbacks
|
|
def setUp(self):
|
|
hs = yield tests.utils.setup_test_homeserver(self.addCleanup)
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
@defer.inlineCallbacks
|
|
def test_store_new_device(self):
|
|
yield defer.ensureDeferred(
|
|
self.store.store_device("user_id", "device_id", "display_name")
|
|
)
|
|
|
|
res = yield defer.ensureDeferred(self.store.get_device("user_id", "device_id"))
|
|
self.assertDictContainsSubset(
|
|
{
|
|
"user_id": "user_id",
|
|
"device_id": "device_id",
|
|
"display_name": "display_name",
|
|
},
|
|
res,
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_devices_by_user(self):
|
|
yield defer.ensureDeferred(
|
|
self.store.store_device("user_id", "device1", "display_name 1")
|
|
)
|
|
yield defer.ensureDeferred(
|
|
self.store.store_device("user_id", "device2", "display_name 2")
|
|
)
|
|
yield defer.ensureDeferred(
|
|
self.store.store_device("user_id2", "device3", "display_name 3")
|
|
)
|
|
|
|
res = yield defer.ensureDeferred(self.store.get_devices_by_user("user_id"))
|
|
self.assertEqual(2, len(res.keys()))
|
|
self.assertDictContainsSubset(
|
|
{
|
|
"user_id": "user_id",
|
|
"device_id": "device1",
|
|
"display_name": "display_name 1",
|
|
},
|
|
res["device1"],
|
|
)
|
|
self.assertDictContainsSubset(
|
|
{
|
|
"user_id": "user_id",
|
|
"device_id": "device2",
|
|
"display_name": "display_name 2",
|
|
},
|
|
res["device2"],
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_device_updates_by_remote(self):
|
|
device_ids = ["device_id1", "device_id2"]
|
|
|
|
# Add two device updates with a single stream_id
|
|
yield defer.ensureDeferred(
|
|
self.store.add_device_change_to_streams("user_id", device_ids, ["somehost"])
|
|
)
|
|
|
|
# Get all device updates ever meant for this remote
|
|
now_stream_id, device_updates = yield defer.ensureDeferred(
|
|
self.store.get_device_updates_by_remote("somehost", -1, limit=100)
|
|
)
|
|
|
|
# Check original device_ids are contained within these updates
|
|
self._check_devices_in_updates(device_ids, device_updates)
|
|
|
|
def _check_devices_in_updates(self, expected_device_ids, device_updates):
|
|
"""Check that an specific device ids exist in a list of device update EDUs"""
|
|
self.assertEqual(len(device_updates), len(expected_device_ids))
|
|
|
|
received_device_ids = {
|
|
update["device_id"] for edu_type, update in device_updates
|
|
}
|
|
self.assertEqual(received_device_ids, set(expected_device_ids))
|
|
|
|
@defer.inlineCallbacks
|
|
def test_update_device(self):
|
|
yield defer.ensureDeferred(
|
|
self.store.store_device("user_id", "device_id", "display_name 1")
|
|
)
|
|
|
|
res = yield defer.ensureDeferred(self.store.get_device("user_id", "device_id"))
|
|
self.assertEqual("display_name 1", res["display_name"])
|
|
|
|
# do a no-op first
|
|
yield defer.ensureDeferred(self.store.update_device("user_id", "device_id"))
|
|
res = yield defer.ensureDeferred(self.store.get_device("user_id", "device_id"))
|
|
self.assertEqual("display_name 1", res["display_name"])
|
|
|
|
# do the update
|
|
yield defer.ensureDeferred(
|
|
self.store.update_device(
|
|
"user_id", "device_id", new_display_name="display_name 2"
|
|
)
|
|
)
|
|
|
|
# check it worked
|
|
res = yield defer.ensureDeferred(self.store.get_device("user_id", "device_id"))
|
|
self.assertEqual("display_name 2", res["display_name"])
|
|
|
|
@defer.inlineCallbacks
|
|
def test_update_unknown_device(self):
|
|
with self.assertRaises(synapse.api.errors.StoreError) as cm:
|
|
yield defer.ensureDeferred(
|
|
self.store.update_device(
|
|
"user_id", "unknown_device_id", new_display_name="display_name 2"
|
|
)
|
|
)
|
|
self.assertEqual(404, cm.exception.code)
|