summary refs log tree commit diff
path: root/tests/storage/test_state.py
blob: b2f314e9db0223b1e2b9686856d027eec1f50ef6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# -*- coding: utf-8 -*-
# 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.

import logging

from twisted.internet import defer

from synapse.api.constants import EventTypes, Membership
from synapse.types import RoomID, UserID

import tests.unittest
import tests.utils

logger = logging.getLogger(__name__)


class StateStoreTestCase(tests.unittest.TestCase):
    def __init__(self, *args, **kwargs):
        super(StateStoreTestCase, self).__init__(*args, **kwargs)
        self.store = None  # type: synapse.storage.DataStore

    @defer.inlineCallbacks
    def setUp(self):
        hs = yield tests.utils.setup_test_homeserver()

        self.store = hs.get_datastore()
        self.event_builder_factory = hs.get_event_builder_factory()
        self.event_creation_handler = hs.get_event_creation_handler()

        self.u_alice = UserID.from_string("@alice:test")
        self.u_bob = UserID.from_string("@bob:test")

        self.room = RoomID.from_string("!abc123:test")

        yield self.store.store_room(
            self.room.to_string(),
            room_creator_user_id="@creator:text",
            is_public=True
        )

    @defer.inlineCallbacks
    def inject_state_event(self, room, sender, typ, state_key, content):
        builder = self.event_builder_factory.new({
            "type": typ,
            "sender": sender.to_string(),
            "state_key": state_key,
            "room_id": room.to_string(),
            "content": content,
        })

        event, context = yield self.event_creation_handler.create_new_client_event(
            builder
        )

        yield self.store.persist_event(event, context)

        defer.returnValue(event)

    def assertStateMapEqual(self, s1, s2):
        for t in s1:
            # just compare event IDs for simplicity
            self.assertEqual(s1[t].event_id, s2[t].event_id)
        self.assertEqual(len(s1), len(s2))

    @defer.inlineCallbacks
    def test_get_state_for_event(self):

        # this defaults to a linear DAG as each new injection defaults to whatever
        # forward extremities are currently in the DB for this room.
        e1 = yield self.inject_state_event(
            self.room, self.u_alice, EventTypes.Create, '', {},
        )
        e2 = yield self.inject_state_event(
            self.room, self.u_alice, EventTypes.Name, '', {
                "name": "test room"
            },
        )
        e3 = yield self.inject_state_event(
            self.room, self.u_alice, EventTypes.Member, self.u_alice.to_string(), {
                "membership": Membership.JOIN
            },
        )
        e4 = yield self.inject_state_event(
            self.room, self.u_bob, EventTypes.Member, self.u_bob.to_string(), {
                "membership": Membership.JOIN
            },
        )
        e5 = yield self.inject_state_event(
            self.room, self.u_bob, EventTypes.Member, self.u_bob.to_string(), {
                "membership": Membership.LEAVE
            },
        )

        # check we get the full state as of the final event
        state = yield self.store.get_state_for_event(
            e5.event_id, None, filtered_types=None
        )

        self.assertIsNotNone(e4)

        self.assertStateMapEqual({
            (e1.type, e1.state_key): e1,
            (e2.type, e2.state_key): e2,
            (e3.type, e3.state_key): e3,
            # e4 is overwritten by e5
            (e5.type, e5.state_key): e5,
        }, state)

        # check we can filter to the m.room.name event (with a '' state key)
        state = yield self.store.get_state_for_event(
            e5.event_id, [(EventTypes.Name, '')], filtered_types=None
        )

        self.assertStateMapEqual({
            (e2.type, e2.state_key): e2,
        }, state)

        # check we can filter to the m.room.name event (with a wildcard None state key)
        state = yield self.store.get_state_for_event(
            e5.event_id, [(EventTypes.Name, None)], filtered_types=None
        )

        self.assertStateMapEqual({
            (e2.type, e2.state_key): e2,
        }, state)

        # check we can grab the m.room.member events (with a wildcard None state key)
        state = yield self.store.get_state_for_event(
            e5.event_id, [(EventTypes.Member, None)], filtered_types=None
        )

        self.assertStateMapEqual({
            (e3.type, e3.state_key): e3,
            (e5.type, e5.state_key): e5,
        }, state)

        # check we can use filter_types to grab a specific room member
        # without filtering out the other event types
        state = yield self.store.get_state_for_event(
            e5.event_id, [(EventTypes.Member, self.u_alice.to_string())],
            filtered_types=[EventTypes.Member],
        )

        self.assertStateMapEqual({
            (e1.type, e1.state_key): e1,
            (e2.type, e2.state_key): e2,
            (e3.type, e3.state_key): e3,
        }, state)

        state = yield self.store.get_state_for_event(
            e5.event_id, [], filtered_types=[EventTypes.Member],
        )

        self.assertStateMapEqual({
            (e1.type, e1.state_key): e1,
            (e2.type, e2.state_key): e2,
        }, state)