summaryrefslogtreecommitdiff
path: root/tests/rest/client/v2_alpha/test_shared_rooms.py
blob: cedb9614a8ae068075b6d7474e94d3a9f7eb4e39 (plain)
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
# Copyright 2020 Half-Shot
#
# 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 synapse.rest.admin
from synapse.rest.client.v1 import login, room
from synapse.rest.client.v2_alpha import shared_rooms

from tests import unittest
from tests.server import FakeChannel


class UserSharedRoomsTest(unittest.HomeserverTestCase):
    """
    Tests the UserSharedRoomsServlet.
    """

    servlets = [
        login.register_servlets,
        synapse.rest.admin.register_servlets_for_client_rest_resource,
        room.register_servlets,
        shared_rooms.register_servlets,
    ]

    def make_homeserver(self, reactor, clock):
        config = self.default_config()
        config["update_user_directory"] = True
        return self.setup_test_homeserver(config=config)

    def prepare(self, reactor, clock, hs):
        self.store = hs.get_datastore()
        self.handler = hs.get_user_directory_handler()

    def _get_shared_rooms(self, token, other_user) -> FakeChannel:
        return self.make_request(
            "GET",
            "/_matrix/client/unstable/uk.half-shot.msc2666/user/shared_rooms/%s"
            % other_user,
            access_token=token,
        )

    def test_shared_room_list_public(self):
        """
        A room should show up in the shared list of rooms between two users
        if it is public.
        """
        self._check_shared_rooms_with(room_one_is_public=True, room_two_is_public=True)

    def test_shared_room_list_private(self):
        """
        A room should show up in the shared list of rooms between two users
        if it is private.
        """
        self._check_shared_rooms_with(
            room_one_is_public=False, room_two_is_public=False
        )

    def test_shared_room_list_mixed(self):
        """
        The shared room list between two users should contain both public and private
        rooms.
        """
        self._check_shared_rooms_with(room_one_is_public=True, room_two_is_public=False)

    def _check_shared_rooms_with(
        self, room_one_is_public: bool, room_two_is_public: bool
    ):
        """Checks that shared public or private rooms between two users appear in
        their shared room lists
        """
        u1 = self.register_user("user1", "pass")
        u1_token = self.login(u1, "pass")
        u2 = self.register_user("user2", "pass")
        u2_token = self.login(u2, "pass")

        # Create a room. user1 invites user2, who joins
        room_id_one = self.helper.create_room_as(
            u1, is_public=room_one_is_public, tok=u1_token
        )
        self.helper.invite(room_id_one, src=u1, targ=u2, tok=u1_token)
        self.helper.join(room_id_one, user=u2, tok=u2_token)

        # Check shared rooms from user1's perspective.
        # We should see the one room in common
        channel = self._get_shared_rooms(u1_token, u2)
        self.assertEquals(200, channel.code, channel.result)
        self.assertEquals(len(channel.json_body["joined"]), 1)
        self.assertEquals(channel.json_body["joined"][0], room_id_one)

        # Create another room and invite user2 to it
        room_id_two = self.helper.create_room_as(
            u1, is_public=room_two_is_public, tok=u1_token
        )
        self.helper.invite(room_id_two, src=u1, targ=u2, tok=u1_token)
        self.helper.join(room_id_two, user=u2, tok=u2_token)

        # Check shared rooms again. We should now see both rooms.
        channel = self._get_shared_rooms(u1_token, u2)
        self.assertEquals(200, channel.code, channel.result)
        self.assertEquals(len(channel.json_body["joined"]), 2)
        for room_id_id in channel.json_body["joined"]:
            self.assertIn(room_id_id, [room_id_one, room_id_two])

    def test_shared_room_list_after_leave(self):
        """
        A room should no longer be considered shared if the other
        user has left it.
        """
        u1 = self.register_user("user1", "pass")
        u1_token = self.login(u1, "pass")
        u2 = self.register_user("user2", "pass")
        u2_token = self.login(u2, "pass")

        room = self.helper.create_room_as(u1, is_public=True, tok=u1_token)
        self.helper.invite(room, src=u1, targ=u2, tok=u1_token)
        self.helper.join(room, user=u2, tok=u2_token)

        # Assert user directory is not empty
        channel = self._get_shared_rooms(u1_token, u2)
        self.assertEquals(200, channel.code, channel.result)
        self.assertEquals(len(channel.json_body["joined"]), 1)
        self.assertEquals(channel.json_body["joined"][0], room)

        self.helper.leave(room, user=u1, tok=u1_token)

        # Check user1's view of shared rooms with user2
        channel = self._get_shared_rooms(u1_token, u2)
        self.assertEquals(200, channel.code, channel.result)
        self.assertEquals(len(channel.json_body["joined"]), 0)

        # Check user2's view of shared rooms with user1
        channel = self._get_shared_rooms(u2_token, u1)
        self.assertEquals(200, channel.code, channel.result)
        self.assertEquals(len(channel.json_body["joined"]), 0)