forked-synapse/tests/server_notices/test_consent.py

112 lines
3.7 KiB
Python
Raw Normal View History

2018-10-01 10:11:58 -04:00
#
2023-11-21 15:29:58 -05:00
# This file is licensed under the Affero General Public License (AGPL) version 3.
#
# Copyright (C) 2023 New Vector, Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# See the GNU Affero General Public License for more details:
# <https://www.gnu.org/licenses/agpl-3.0.html>.
#
# Originally licensed under the Apache License, Version 2.0:
# <http://www.apache.org/licenses/LICENSE-2.0>.
#
# [This file includes modifications made by New Vector Limited]
2018-10-01 10:11:58 -04:00
#
#
import os
from twisted.test.proto_helpers import MemoryReactor
import synapse.rest.admin
from synapse.rest.client import login, room, sync
from synapse.server import HomeServer
from synapse.util import Clock
2018-10-01 10:11:58 -04:00
from tests import unittest
class ConsentNoticesTests(unittest.HomeserverTestCase):
servlets = [
sync.register_servlets,
synapse.rest.admin.register_servlets_for_client_rest_resource,
2018-10-01 10:11:58 -04:00
login.register_servlets,
room.register_servlets,
]
def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
tmpdir = self.mktemp()
os.mkdir(tmpdir)
2018-10-01 10:11:58 -04:00
self.consent_notice_message = "consent %(consent_uri)s"
config = self.default_config()
config["user_consent"] = {
"version": "1",
"template_dir": tmpdir,
"server_notice_content": {
"msgtype": "m.text",
"body": self.consent_notice_message,
},
2018-10-01 10:11:58 -04:00
}
config["public_baseurl"] = "https://example.com/"
config["form_secret"] = "123abc"
2018-10-01 10:11:58 -04:00
config["server_notices"] = {
"system_mxid_localpart": "notices",
"system_mxid_display_name": "test display name",
"system_mxid_avatar_url": None,
"room_name": "Server Notices",
}
2018-10-01 10:11:58 -04:00
return self.setup_test_homeserver(config=config)
2018-10-01 10:11:58 -04:00
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
2018-10-01 10:11:58 -04:00
self.user_id = self.register_user("bob", "abc123")
self.access_token = self.login("bob", "abc123")
def test_get_sync_message(self) -> None:
2018-10-01 10:11:58 -04:00
"""
When user consent server notices are enabled, a sync will cause a notice
to fire (in a room which the user is invited to). The notice contains
the notice URL + an authentication code.
"""
# Initial sync, to get the user consent room invite
channel = self.make_request(
2018-10-01 10:11:58 -04:00
"GET", "/_matrix/client/r0/sync", access_token=self.access_token
)
self.assertEqual(channel.code, 200)
# Get the Room ID to join
room_id = list(channel.json_body["rooms"]["invite"].keys())[0]
# Join the room
channel = self.make_request(
2018-10-01 10:11:58 -04:00
"POST",
"/_matrix/client/r0/rooms/" + room_id + "/join",
access_token=self.access_token,
)
self.assertEqual(channel.code, 200)
# Sync again, to get the message in the room
channel = self.make_request(
2018-10-01 10:11:58 -04:00
"GET", "/_matrix/client/r0/sync", access_token=self.access_token
)
self.assertEqual(channel.code, 200)
# Get the message
room = channel.json_body["rooms"]["join"][room_id]
messages = [
x for x in room["timeline"]["events"] if x["type"] == "m.room.message"
]
# One message, with the consent URL
self.assertEqual(len(messages), 1)
self.assertTrue(
messages[0]["content"]["body"].startswith(
"consent https://example.com/_matrix/consent"
)
)