Skip to content
Snippets Groups Projects
test_redaction.py 6.24 KiB
Newer Older
  • Learn to ignore specific revisions
  • Erik Johnston's avatar
    Erik Johnston committed
    # -*- coding: utf-8 -*-
    
    Matthew Hodgson's avatar
    Matthew Hodgson committed
    # Copyright 2014-2016 OpenMarket Ltd
    
    Erik Johnston's avatar
    Erik Johnston committed
    #
    # 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 tests import unittest
    from twisted.internet import defer
    
    
    from synapse.api.constants import EventTypes, Membership
    
    from synapse.types import UserID, RoomID
    
    from tests.utils import setup_test_homeserver
    
    Erik Johnston's avatar
    Erik Johnston committed
    
    from mock import Mock
    
    class RedactionTestCase(unittest.TestCase):
    
    Erik Johnston's avatar
    Erik Johnston committed
    
        @defer.inlineCallbacks
        def setUp(self):
    
            hs = yield setup_test_homeserver(
    
    Erik Johnston's avatar
    Erik Johnston committed
                resource_for_federation=Mock(),
                http_client=None,
    
    Erik Johnston's avatar
    Erik Johnston committed
            )
    
            self.store = hs.get_datastore()
    
    Erik Johnston's avatar
    Erik Johnston committed
            self.event_builder_factory = hs.get_event_builder_factory()
    
    Erik Johnston's avatar
    Erik Johnston committed
            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.room1 = RoomID.from_string("!abc123:test")
    
    Erik Johnston's avatar
    Erik Johnston committed
    
            self.depth = 1
    
        @defer.inlineCallbacks
    
    Erik Johnston's avatar
    Erik Johnston committed
        def inject_room_member(self, room, user, membership, replaces_state=None,
    
    Erik Johnston's avatar
    Erik Johnston committed
                               extra_content={}):
    
    Erik Johnston's avatar
    Erik Johnston committed
            content = {"membership": membership}
            content.update(extra_content)
            builder = self.event_builder_factory.new({
    
                "type": EventTypes.Member,
    
    Erik Johnston's avatar
    Erik Johnston committed
                "sender": user.to_string(),
                "state_key": user.to_string(),
                "room_id": room.to_string(),
                "content": content,
            })
    
    
            event, context = yield self.event_creation_handler.create_new_client_event(
    
    Erik Johnston's avatar
    Erik Johnston committed
                builder
    
    Erik Johnston's avatar
    Erik Johnston committed
            yield self.store.persist_event(event, context)
    
    Erik Johnston's avatar
    Erik Johnston committed
    
            defer.returnValue(event)
    
        @defer.inlineCallbacks
        def inject_message(self, room, user, body):
            self.depth += 1
    
    
    Erik Johnston's avatar
    Erik Johnston committed
            builder = self.event_builder_factory.new({
    
                "type": EventTypes.Message,
    
    Erik Johnston's avatar
    Erik Johnston committed
                "sender": user.to_string(),
                "state_key": user.to_string(),
                "room_id": room.to_string(),
                "content": {"body": body, "msgtype": u"message"},
            })
    
            event, context = yield self.event_creation_handler.create_new_client_event(
    
    Erik Johnston's avatar
    Erik Johnston committed
                builder
    
    Erik Johnston's avatar
    Erik Johnston committed
            yield self.store.persist_event(event, context)
    
    
    Erik Johnston's avatar
    Erik Johnston committed
            defer.returnValue(event)
    
        @defer.inlineCallbacks
        def inject_redaction(self, room, event_id, user, reason):
    
    Erik Johnston's avatar
    Erik Johnston committed
            builder = self.event_builder_factory.new({
    
                "type": EventTypes.Redaction,
    
    Erik Johnston's avatar
    Erik Johnston committed
                "sender": user.to_string(),
                "state_key": user.to_string(),
                "room_id": room.to_string(),
                "content": {"reason": reason},
                "redacts": event_id,
            })
    
    
            event, context = yield self.event_creation_handler.create_new_client_event(
    
    Erik Johnston's avatar
    Erik Johnston committed
                builder
    
    Erik Johnston's avatar
    Erik Johnston committed
            yield self.store.persist_event(event, context)
    
    Erik Johnston's avatar
    Erik Johnston committed
    
        @defer.inlineCallbacks
        def test_redact(self):
            yield self.inject_room_member(
                self.room1, self.u_alice, Membership.JOIN
            )
    
            msg_event = yield self.inject_message(self.room1, self.u_alice, u"t")
    
            # Check event has not been redacted:
    
            event = yield self.store.get_event(msg_event.event_id)
    
    Erik Johnston's avatar
    Erik Johnston committed
    
            self.assertObjectHasAttributes(
                {
    
                    "type": EventTypes.Message,
    
    Erik Johnston's avatar
    Erik Johnston committed
                    "user_id": self.u_alice.to_string(),
                    "content": {"body": "t", "msgtype": "message"},
                },
                event,
            )
    
    
            self.assertFalse("redacted_because" in event.unsigned)
    
    Erik Johnston's avatar
    Erik Johnston committed
    
            # Redact event
            reason = "Because I said so"
            yield self.inject_redaction(
                self.room1, msg_event.event_id, self.u_alice, reason
            )
    
    
            event = yield self.store.get_event(msg_event.event_id)
    
    Erik Johnston's avatar
    Erik Johnston committed
            self.assertEqual(msg_event.event_id, event.event_id)
    
            self.assertTrue("redacted_because" in event.unsigned)
    
    
    Erik Johnston's avatar
    Erik Johnston committed
            self.assertObjectHasAttributes(
                {
    
                    "type": EventTypes.Message,
    
    Erik Johnston's avatar
    Erik Johnston committed
                    "user_id": self.u_alice.to_string(),
                    "content": {},
                },
                event,
            )
    
            self.assertObjectHasAttributes(
                {
    
                    "type": EventTypes.Redaction,
    
    Erik Johnston's avatar
    Erik Johnston committed
                    "user_id": self.u_alice.to_string(),
                    "content": {"reason": reason},
                },
    
                event.unsigned["redacted_because"],
    
    Erik Johnston's avatar
    Erik Johnston committed
    
        @defer.inlineCallbacks
        def test_redact_join(self):
            yield self.inject_room_member(
                self.room1, self.u_alice, Membership.JOIN
            )
    
            msg_event = yield self.inject_room_member(
                self.room1, self.u_bob, Membership.JOIN,
                extra_content={"blue": "red"},
            )
    
    
            event = yield self.store.get_event(msg_event.event_id)
    
    Erik Johnston's avatar
    Erik Johnston committed
    
            self.assertObjectHasAttributes(
                {
    
                    "type": EventTypes.Member,
    
    Erik Johnston's avatar
    Erik Johnston committed
                    "user_id": self.u_bob.to_string(),
                    "content": {"membership": Membership.JOIN, "blue": "red"},
                },
                event,
            )
    
            self.assertFalse(hasattr(event, "redacted_because"))
    
            # Redact event
            reason = "Because I said so"
            yield self.inject_redaction(
                self.room1, msg_event.event_id, self.u_alice, reason
            )
    
            # Check redaction
    
    
            event = yield self.store.get_event(msg_event.event_id)
    
    Erik Johnston's avatar
    Erik Johnston committed
    
    
    Erik Johnston's avatar
    Erik Johnston committed
            self.assertTrue("redacted_because" in event.unsigned)
    
    
    Erik Johnston's avatar
    Erik Johnston committed
            self.assertObjectHasAttributes(
                {
    
                    "type": EventTypes.Member,
    
    Erik Johnston's avatar
    Erik Johnston committed
                    "user_id": self.u_bob.to_string(),
                    "content": {"membership": Membership.JOIN},
                },
                event,
            )
    
            self.assertObjectHasAttributes(
                {
    
                    "type": EventTypes.Redaction,
    
    Erik Johnston's avatar
    Erik Johnston committed
                    "user_id": self.u_alice.to_string(),
                    "content": {"reason": reason},
                },
    
    Erik Johnston's avatar
    Erik Johnston committed
                event.unsigned["redacted_because"],
    
    Erik Johnston's avatar
    Erik Johnston committed
            )