synapse-old/tests/events/test_utils.py

305 lines
8.4 KiB
Python
Raw Normal View History

2015-10-16 12:56:46 -06:00
# -*- coding: utf-8 -*-
2016-01-06 21:26:29 -07:00
# Copyright 2015, 2016 OpenMarket Ltd
2015-10-16 12:56:46 -06: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.
from synapse.events import FrozenEvent
2016-11-21 10:52:45 -07:00
from synapse.events.utils import prune_event, serialize_event
2018-07-09 00:09:20 -06:00
from .. import unittest
2016-11-21 10:52:45 -07:00
def MockEvent(**kwargs):
2017-01-13 06:16:54 -07:00
if "event_id" not in kwargs:
kwargs["event_id"] = "fake_event_id"
if "type" not in kwargs:
kwargs["type"] = "fake_type"
2016-11-21 10:52:45 -07:00
return FrozenEvent(kwargs)
2015-10-16 12:56:46 -06:00
2016-02-19 08:34:38 -07:00
2015-10-16 12:56:46 -06:00
class PruneEventTestCase(unittest.TestCase):
""" Asserts that a new event constructed with `evdict` will look like
`matchdict` when it is redacted. """
def run_test(self, evdict, matchdict):
self.assertEquals(
prune_event(FrozenEvent(evdict)).get_dict(),
matchdict
)
def test_minimal(self):
self.run_test(
{
'type': 'A',
2017-01-13 06:16:54 -07:00
'event_id': '$test:domain',
},
{
'type': 'A',
'event_id': '$test:domain',
2015-10-16 12:56:46 -06:00
'content': {},
'signatures': {},
'unsigned': {},
}
)
def test_basic_keys(self):
self.run_test(
{
'type': 'A',
'room_id': '!1:domain',
'sender': '@2:domain',
'event_id': '$3:domain',
'origin': 'domain',
},
{
'type': 'A',
'room_id': '!1:domain',
'sender': '@2:domain',
'event_id': '$3:domain',
'origin': 'domain',
'content': {},
'signatures': {},
'unsigned': {},
}
)
def test_unsigned_age_ts(self):
self.run_test(
{
'type': 'B',
2017-01-13 06:16:54 -07:00
'event_id': '$test:domain',
2015-10-16 12:56:46 -06:00
'unsigned': {'age_ts': 20},
},
{
'type': 'B',
2017-01-13 06:16:54 -07:00
'event_id': '$test:domain',
2015-10-16 12:56:46 -06:00
'content': {},
'signatures': {},
'unsigned': {'age_ts': 20},
}
)
self.run_test(
{
'type': 'B',
2017-01-13 06:16:54 -07:00
'event_id': '$test:domain',
2015-10-16 12:56:46 -06:00
'unsigned': {'other_key': 'here'},
},
{
'type': 'B',
2017-01-13 06:16:54 -07:00
'event_id': '$test:domain',
2015-10-16 12:56:46 -06:00
'content': {},
'signatures': {},
'unsigned': {},
}
)
def test_content(self):
self.run_test(
{
'type': 'C',
2017-01-13 06:16:54 -07:00
'event_id': '$test:domain',
2015-10-16 12:56:46 -06:00
'content': {'things': 'here'},
},
{
'type': 'C',
2017-01-13 06:16:54 -07:00
'event_id': '$test:domain',
2015-10-16 12:56:46 -06:00
'content': {},
'signatures': {},
'unsigned': {},
}
)
self.run_test(
{
'type': 'm.room.create',
2017-01-13 06:16:54 -07:00
'event_id': '$test:domain',
2015-10-16 12:56:46 -06:00
'content': {'creator': '@2:domain', 'other_field': 'here'},
},
{
'type': 'm.room.create',
2017-01-13 06:16:54 -07:00
'event_id': '$test:domain',
2015-10-16 12:56:46 -06:00
'content': {'creator': '@2:domain'},
'signatures': {},
'unsigned': {},
}
)
class SerializeEventTestCase(unittest.TestCase):
2016-11-21 10:52:45 -07:00
def serialize(self, ev, fields):
2016-11-22 02:59:27 -07:00
return serialize_event(ev, 1479807801915, only_event_fields=fields)
2016-11-21 10:52:45 -07:00
def test_event_fields_works_with_keys(self):
2016-11-21 10:52:45 -07:00
self.assertEquals(
self.serialize(
MockEvent(
sender="@alice:localhost",
room_id="!foo:bar"
),
["room_id"]
),
{
"room_id": "!foo:bar",
}
)
def test_event_fields_works_with_nested_keys(self):
2016-11-21 10:52:45 -07:00
self.assertEquals(
self.serialize(
MockEvent(
sender="@alice:localhost",
room_id="!foo:bar",
content={
"body": "A message",
},
),
["content.body"]
),
{
"content": {
"body": "A message",
}
}
)
def test_event_fields_works_with_dot_keys(self):
2016-11-21 10:58:22 -07:00
self.assertEquals(
self.serialize(
MockEvent(
sender="@alice:localhost",
room_id="!foo:bar",
content={
"key.with.dots": {},
},
),
["content.key\.with\.dots"]
),
{
"content": {
"key.with.dots": {},
}
}
)
def test_event_fields_works_with_nested_dot_keys(self):
2016-11-21 10:58:22 -07:00
self.assertEquals(
self.serialize(
MockEvent(
sender="@alice:localhost",
room_id="!foo:bar",
content={
"not_me": 1,
"nested.dot.key": {
"leaf.key": 42,
"not_me_either": 1,
},
},
),
["content.nested\.dot\.key.leaf\.key"]
),
{
"content": {
"nested.dot.key": {
"leaf.key": 42,
},
}
}
)
def test_event_fields_nops_with_unknown_keys(self):
2016-11-21 10:58:22 -07:00
self.assertEquals(
self.serialize(
MockEvent(
sender="@alice:localhost",
room_id="!foo:bar",
content={
"foo": "bar",
},
),
["content.foo", "content.notexists"]
),
{
"content": {
"foo": "bar",
}
}
)
def test_event_fields_nops_with_non_dict_keys(self):
2016-11-21 10:58:22 -07:00
self.assertEquals(
self.serialize(
MockEvent(
sender="@alice:localhost",
room_id="!foo:bar",
content={
"foo": ["I", "am", "an", "array"],
},
),
["content.foo.am"]
),
{}
)
2016-11-22 02:59:27 -07:00
def test_event_fields_nops_with_array_keys(self):
self.assertEquals(
self.serialize(
MockEvent(
sender="@alice:localhost",
room_id="!foo:bar",
content={
"foo": ["I", "am", "an", "array"],
},
),
["content.foo.1"]
),
{}
)
def test_event_fields_all_fields_if_empty(self):
self.assertEquals(
self.serialize(
MockEvent(
2017-01-13 06:16:54 -07:00
type="foo",
event_id="test",
2016-11-22 02:59:27 -07:00
room_id="!foo:bar",
content={
"foo": "bar",
},
),
[]
),
{
2017-01-13 06:16:54 -07:00
"type": "foo",
"event_id": "test",
2016-11-22 02:59:27 -07:00
"room_id": "!foo:bar",
"content": {
"foo": "bar",
},
"unsigned": {}
}
)
def test_event_fields_fail_if_fields_not_str(self):
2016-11-22 06:42:11 -07:00
with self.assertRaises(TypeError):
2016-11-22 02:59:27 -07:00
self.serialize(
MockEvent(
room_id="!foo:bar",
content={
"foo": "bar",
},
),
["room_id", 4]
2016-11-22 06:42:11 -07:00
)