Skip to content
Snippets Groups Projects
test_admin.py 9.23 KiB
Newer Older
  • Learn to ignore specific revisions
  • # Copyright 2019 The Matrix.org Foundation C.I.C.
    #
    # 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 collections import Counter
    
    from unittest.mock import Mock
    
    
    import synapse.rest.admin
    import synapse.storage
    
    from synapse.api.constants import EventTypes, JoinRules
    from synapse.api.room_versions import RoomVersions
    from synapse.rest.client import knock, login, room
    
    
    from tests import unittest
    
    
    class ExfiltrateData(unittest.HomeserverTestCase):
        servlets = [
            synapse.rest.admin.register_servlets_for_client_rest_resource,
            login.register_servlets,
            room.register_servlets,
    
        ]
    
        def prepare(self, reactor, clock, hs):
    
            self.admin_handler = hs.get_admin_handler()
    
    
            self.user1 = self.register_user("user1", "password")
            self.token1 = self.login("user1", "password")
    
            self.user2 = self.register_user("user2", "password")
            self.token2 = self.login("user2", "password")
    
        def test_single_public_joined_room(self):
    
            """Test that we write *all* events for a public room"""
    
            room_id = self.helper.create_room_as(
                self.user1, tok=self.token1, is_public=True
            )
            self.helper.send(room_id, body="Hello!", tok=self.token1)
            self.helper.join(room_id, self.user2, tok=self.token2)
            self.helper.send(room_id, body="Hello again!", tok=self.token1)
    
            writer = Mock()
    
    
            self.get_success(self.admin_handler.export_user_data(self.user2, writer))
    
    
            writer.write_events.assert_called()
    
            # Since we can see all events there shouldn't be any extremities, so no
            # state should be written
            writer.write_state.assert_not_called()
    
            # Collect all events that were written
            written_events = []
            for (called_room_id, events), _ in writer.write_events.call_args_list:
                self.assertEqual(called_room_id, room_id)
                written_events.extend(events)
    
            # Check that the right number of events were written
            counter = Counter(
                (event.type, getattr(event, "state_key", None)) for event in written_events
            )
            self.assertEqual(counter[(EventTypes.Message, None)], 2)
            self.assertEqual(counter[(EventTypes.Member, self.user1)], 1)
            self.assertEqual(counter[(EventTypes.Member, self.user2)], 1)
    
        def test_single_private_joined_room(self):
            """Tests that we correctly write state when we can't see all events in
            a room.
            """
            room_id = self.helper.create_room_as(self.user1, tok=self.token1)
            self.helper.send_state(
                room_id,
                EventTypes.RoomHistoryVisibility,
                body={"history_visibility": "joined"},
                tok=self.token1,
            )
            self.helper.send(room_id, body="Hello!", tok=self.token1)
            self.helper.join(room_id, self.user2, tok=self.token2)
            self.helper.send(room_id, body="Hello again!", tok=self.token1)
    
            writer = Mock()
    
    
            self.get_success(self.admin_handler.export_user_data(self.user2, writer))
    
    
            writer.write_events.assert_called()
    
            # Since we can't see all events there should be one extremity.
            writer.write_state.assert_called_once()
    
            # Collect all events that were written
            written_events = []
            for (called_room_id, events), _ in writer.write_events.call_args_list:
                self.assertEqual(called_room_id, room_id)
                written_events.extend(events)
    
            # Check that the right number of events were written
            counter = Counter(
                (event.type, getattr(event, "state_key", None)) for event in written_events
            )
            self.assertEqual(counter[(EventTypes.Message, None)], 1)
            self.assertEqual(counter[(EventTypes.Member, self.user1)], 1)
            self.assertEqual(counter[(EventTypes.Member, self.user2)], 1)
    
        def test_single_left_room(self):
    
            """Tests that we don't see events in the room after we leave."""
    
            room_id = self.helper.create_room_as(self.user1, tok=self.token1)
            self.helper.send(room_id, body="Hello!", tok=self.token1)
            self.helper.join(room_id, self.user2, tok=self.token2)
            self.helper.send(room_id, body="Hello again!", tok=self.token1)
            self.helper.leave(room_id, self.user2, tok=self.token2)
            self.helper.send(room_id, body="Helloooooo!", tok=self.token1)
    
            writer = Mock()
    
    
            self.get_success(self.admin_handler.export_user_data(self.user2, writer))
    
    
            writer.write_events.assert_called()
    
            # Since we can see all events there shouldn't be any extremities, so no
            # state should be written
            writer.write_state.assert_not_called()
    
            written_events = []
            for (called_room_id, events), _ in writer.write_events.call_args_list:
                self.assertEqual(called_room_id, room_id)
                written_events.extend(events)
    
            # Check that the right number of events were written
            counter = Counter(
                (event.type, getattr(event, "state_key", None)) for event in written_events
            )
            self.assertEqual(counter[(EventTypes.Message, None)], 2)
            self.assertEqual(counter[(EventTypes.Member, self.user1)], 1)
            self.assertEqual(counter[(EventTypes.Member, self.user2)], 2)
    
        def test_single_left_rejoined_private_room(self):
            """Tests that see the correct events in private rooms when we
            repeatedly join and leave.
            """
            room_id = self.helper.create_room_as(self.user1, tok=self.token1)
            self.helper.send_state(
                room_id,
                EventTypes.RoomHistoryVisibility,
                body={"history_visibility": "joined"},
                tok=self.token1,
            )
            self.helper.send(room_id, body="Hello!", tok=self.token1)
            self.helper.join(room_id, self.user2, tok=self.token2)
            self.helper.send(room_id, body="Hello again!", tok=self.token1)
            self.helper.leave(room_id, self.user2, tok=self.token2)
            self.helper.send(room_id, body="Helloooooo!", tok=self.token1)
            self.helper.join(room_id, self.user2, tok=self.token2)
            self.helper.send(room_id, body="Helloooooo!!", tok=self.token1)
    
            writer = Mock()
    
    
            self.get_success(self.admin_handler.export_user_data(self.user2, writer))
    
    
            writer.write_events.assert_called_once()
    
            # Since we joined/left/joined again we expect there to be two gaps.
            self.assertEqual(writer.write_state.call_count, 2)
    
            written_events = []
            for (called_room_id, events), _ in writer.write_events.call_args_list:
                self.assertEqual(called_room_id, room_id)
                written_events.extend(events)
    
            # Check that the right number of events were written
            counter = Counter(
                (event.type, getattr(event, "state_key", None)) for event in written_events
            )
            self.assertEqual(counter[(EventTypes.Message, None)], 2)
            self.assertEqual(counter[(EventTypes.Member, self.user1)], 1)
            self.assertEqual(counter[(EventTypes.Member, self.user2)], 3)
    
        def test_invite(self):
    
            """Tests that pending invites get handled correctly."""
    
            room_id = self.helper.create_room_as(self.user1, tok=self.token1)
            self.helper.send(room_id, body="Hello!", tok=self.token1)
            self.helper.invite(room_id, self.user1, self.user2, tok=self.token1)
    
            writer = Mock()
    
    
            self.get_success(self.admin_handler.export_user_data(self.user2, writer))
    
    
            writer.write_events.assert_not_called()
            writer.write_state.assert_not_called()
            writer.write_invite.assert_called_once()
    
            args = writer.write_invite.call_args[0]
            self.assertEqual(args[0], room_id)
            self.assertEqual(args[1].content["membership"], "invite")
            self.assertTrue(args[2])  # Assert there is at least one bit of state
    
    
        def test_knock(self):
            """Tests that knock get handled correctly."""
            # create a knockable v7 room
            room_id = self.helper.create_room_as(
                self.user1, room_version=RoomVersions.V7.identifier, tok=self.token1
            )
            self.helper.send_state(
                room_id,
                EventTypes.JoinRules,
                {"join_rule": JoinRules.KNOCK},
                tok=self.token1,
            )
    
            self.helper.send(room_id, body="Hello!", tok=self.token1)
            self.helper.knock(room_id, self.user2, tok=self.token2)
    
            writer = Mock()
    
            self.get_success(self.admin_handler.export_user_data(self.user2, writer))
    
            writer.write_events.assert_not_called()
            writer.write_state.assert_not_called()
            writer.write_knock.assert_called_once()
    
            args = writer.write_knock.call_args[0]
            self.assertEqual(args[0], room_id)
            self.assertEqual(args[1].content["membership"], "knock")
            self.assertTrue(args[2])  # Assert there is at least one bit of state