forked-synapse/tests/rest/client/v1/utils.py

255 lines
8.1 KiB
Python
Raw Normal View History

2014-08-12 10:10:52 -04:00
# -*- coding: utf-8 -*-
2016-01-06 23:26:29 -05:00
# Copyright 2014-2016 OpenMarket 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.
2018-07-09 02:09:20 -04:00
import json
import time
import attr
2014-08-12 10:10:52 -04:00
from twisted.internet import defer
from synapse.api.constants import Membership
2018-07-09 02:09:20 -04:00
from tests import unittest
2018-08-15 09:43:41 -04:00
from tests.server import make_request, render
2014-08-12 10:10:52 -04:00
2014-08-12 10:10:52 -04:00
class RestTestCase(unittest.TestCase):
"""Contains extra helper functions to quickly and clearly perform a given
REST action, which isn't the focus of the test.
This subclass assumes there are mock_resource and auth_user_id attributes.
2014-08-12 10:10:52 -04:00
"""
def __init__(self, *args, **kwargs):
super(RestTestCase, self).__init__(*args, **kwargs)
self.mock_resource = None
2014-08-12 10:10:52 -04:00
self.auth_user_id = None
@defer.inlineCallbacks
def create_room_as(self, room_creator, is_public=True, tok=None):
2014-08-12 10:10:52 -04:00
temp_id = self.auth_user_id
self.auth_user_id = room_creator
path = "/createRoom"
2014-08-12 10:10:52 -04:00
content = "{}"
if not is_public:
content = '{"visibility":"private"}'
if tok:
path = path + "?access_token=%s" % tok
(code, response) = yield self.mock_resource.trigger("POST", path, content)
2014-08-12 10:10:52 -04:00
self.assertEquals(200, code, msg=str(response))
self.auth_user_id = temp_id
defer.returnValue(response["room_id"])
2014-08-12 10:10:52 -04:00
@defer.inlineCallbacks
def invite(self, room=None, src=None, targ=None, expect_code=200, tok=None):
2018-08-10 09:54:09 -04:00
yield self.change_membership(
room=room,
src=src,
targ=targ,
tok=tok,
membership=Membership.INVITE,
expect_code=expect_code,
)
2014-08-12 10:10:52 -04:00
@defer.inlineCallbacks
def join(self, room=None, user=None, expect_code=200, tok=None):
2018-08-10 09:54:09 -04:00
yield self.change_membership(
room=room,
src=user,
targ=user,
tok=tok,
membership=Membership.JOIN,
expect_code=expect_code,
)
2014-08-12 10:10:52 -04:00
@defer.inlineCallbacks
def leave(self, room=None, user=None, expect_code=200, tok=None):
2018-08-10 09:54:09 -04:00
yield self.change_membership(
room=room,
src=user,
targ=user,
tok=tok,
membership=Membership.LEAVE,
expect_code=expect_code,
)
2014-08-12 10:10:52 -04:00
@defer.inlineCallbacks
2018-08-10 09:54:09 -04:00
def change_membership(self, room, src, targ, membership, tok=None, expect_code=200):
2014-08-12 10:10:52 -04:00
temp_id = self.auth_user_id
self.auth_user_id = src
2014-08-26 10:54:25 -04:00
path = "/rooms/%s/state/m.room.member/%s" % (room, targ)
2014-08-12 10:10:52 -04:00
if tok:
path = path + "?access_token=%s" % tok
2018-08-10 09:54:09 -04:00
data = {"membership": membership}
2014-08-26 10:54:25 -04:00
2016-02-19 10:34:38 -05:00
(code, response) = yield self.mock_resource.trigger(
"PUT", path, json.dumps(data)
)
self.assertEquals(
2018-08-10 09:54:09 -04:00
expect_code,
code,
msg="Expected: %d, got: %d, resp: %r" % (expect_code, code, response),
)
2014-08-12 10:10:52 -04:00
self.auth_user_id = temp_id
@defer.inlineCallbacks
def register(self, user_id):
2014-09-15 10:14:19 -04:00
(code, response) = yield self.mock_resource.trigger(
"POST",
"/register",
2018-08-10 09:54:09 -04:00
json.dumps(
{"user": user_id, "password": "test", "type": "m.login.password"}
),
)
2018-08-08 22:22:01 -04:00
self.assertEquals(200, code, msg=response)
2014-08-12 10:10:52 -04:00
defer.returnValue(response)
@defer.inlineCallbacks
2018-08-10 09:54:09 -04:00
def send(self, room_id, body=None, txn_id=None, tok=None, expect_code=200):
if txn_id is None:
txn_id = "m%s" % (str(time.time()))
2014-08-12 10:10:52 -04:00
if body is None:
body = "body_text_here"
path = "/rooms/%s/send/m.room.message/%s" % (room_id, txn_id)
2014-08-12 10:10:52 -04:00
content = '{"msgtype":"m.text","body":"%s"}' % body
if tok:
path = path + "?access_token=%s" % tok
(code, response) = yield self.mock_resource.trigger("PUT", path, content)
2014-08-12 10:10:52 -04:00
self.assertEquals(expect_code, code, msg=str(response))
def assert_dict(self, required, actual):
"""Does a partial assert of a dict.
Args:
required (dict): The keys and value which MUST be in 'actual'.
actual (dict): The test result. Extra keys will not be checked.
"""
for key in required:
2018-08-10 09:54:09 -04:00
self.assertEquals(
required[key], actual[key], msg="%s mismatch. %s" % (key, actual)
)
@attr.s
class RestHelper(object):
"""Contains extra helper functions to quickly and clearly perform a given
REST action, which isn't the focus of the test.
"""
hs = attr.ib()
resource = attr.ib()
auth_user_id = attr.ib()
def create_room_as(self, room_creator, is_public=True, tok=None):
temp_id = self.auth_user_id
self.auth_user_id = room_creator
2018-08-08 22:22:01 -04:00
path = "/_matrix/client/r0/createRoom"
content = {}
if not is_public:
content["visibility"] = "private"
if tok:
2018-08-08 22:22:01 -04:00
path = path + "?access_token=%s" % tok
2018-08-10 09:54:09 -04:00
request, channel = make_request(
self.hs.get_reactor(), "POST", path, json.dumps(content).encode('utf8')
2018-08-10 09:54:09 -04:00
)
2018-08-15 09:43:41 -04:00
render(request, self.resource, self.hs.get_reactor())
assert channel.result["code"] == b"200", channel.result
self.auth_user_id = temp_id
return channel.json_body["room_id"]
def invite(self, room=None, src=None, targ=None, expect_code=200, tok=None):
self.change_membership(
room=room,
src=src,
targ=targ,
tok=tok,
membership=Membership.INVITE,
expect_code=expect_code,
)
def join(self, room=None, user=None, expect_code=200, tok=None):
self.change_membership(
room=room,
src=user,
targ=user,
tok=tok,
membership=Membership.JOIN,
expect_code=expect_code,
)
def leave(self, room=None, user=None, expect_code=200, tok=None):
self.change_membership(
room=room,
src=user,
targ=user,
tok=tok,
membership=Membership.LEAVE,
expect_code=expect_code,
)
def change_membership(self, room, src, targ, membership, tok=None, expect_code=200):
temp_id = self.auth_user_id
self.auth_user_id = src
path = "/_matrix/client/r0/rooms/%s/state/m.room.member/%s" % (room, targ)
if tok:
path = path + "?access_token=%s" % tok
data = {"membership": membership}
request, channel = make_request(
self.hs.get_reactor(), "PUT", path, json.dumps(data).encode('utf8')
)
2018-08-15 09:43:41 -04:00
render(request, self.resource, self.hs.get_reactor())
assert int(channel.result["code"]) == expect_code, (
"Expected: %d, got: %d, resp: %r"
% (expect_code, int(channel.result["code"]), channel.result["body"])
)
self.auth_user_id = temp_id
def send(self, room_id, body=None, txn_id=None, tok=None, expect_code=200):
if txn_id is None:
txn_id = "m%s" % (str(time.time()))
if body is None:
body = "body_text_here"
path = "/_matrix/client/r0/rooms/%s/send/m.room.message/%s" % (room_id, txn_id)
2018-08-30 10:19:58 -04:00
content = {"msgtype": "m.text", "body": body}
if tok:
path = path + "?access_token=%s" % tok
request, channel = make_request(
self.hs.get_reactor(), "PUT", path, json.dumps(content).encode('utf8')
)
2018-08-30 10:19:58 -04:00
render(request, self.resource, self.hs.get_reactor())
assert int(channel.result["code"]) == expect_code, (
"Expected: %d, got: %d, resp: %r"
% (expect_code, int(channel.result["code"]), channel.result["body"])
)
return channel.json_body