123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472 |
- # Copyright 2018 New Vector 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.
- import re
- from http import HTTPStatus
- from typing import Tuple
- from twisted.internet.defer import Deferred
- from twisted.web.resource import Resource
- from synapse.api.errors import Codes, RedirectException, SynapseError
- from synapse.config.server import parse_listener_def
- from synapse.http.server import (
- DirectServeHtmlResource,
- DirectServeJsonResource,
- JsonResource,
- OptionsResource,
- cancellable,
- )
- from synapse.http.site import SynapseRequest, SynapseSite
- from synapse.logging.context import make_deferred_yieldable
- from synapse.types import JsonDict
- from synapse.util import Clock
- from tests import unittest
- from tests.http.server._base import EndpointCancellationTestHelperMixin
- from tests.server import (
- FakeSite,
- ThreadedMemoryReactorClock,
- make_request,
- setup_test_homeserver,
- )
- class JsonResourceTests(unittest.TestCase):
- def setUp(self):
- self.reactor = ThreadedMemoryReactorClock()
- self.hs_clock = Clock(self.reactor)
- self.homeserver = setup_test_homeserver(
- self.addCleanup,
- federation_http_client=None,
- clock=self.hs_clock,
- reactor=self.reactor,
- )
- def test_handler_for_request(self):
- """
- JsonResource.handler_for_request gives correctly decoded URL args to
- the callback, while Twisted will give the raw bytes of URL query
- arguments.
- """
- got_kwargs = {}
- def _callback(request, **kwargs):
- got_kwargs.update(kwargs)
- return 200, kwargs
- res = JsonResource(self.homeserver)
- res.register_paths(
- "GET",
- [re.compile("^/_matrix/foo/(?P<room_id>[^/]*)$")],
- _callback,
- "test_servlet",
- )
- make_request(
- self.reactor,
- FakeSite(res, self.reactor),
- b"GET",
- b"/_matrix/foo/%E2%98%83?a=%E2%98%83",
- )
- self.assertEqual(got_kwargs, {"room_id": "\N{SNOWMAN}"})
- def test_callback_direct_exception(self):
- """
- If the web callback raises an uncaught exception, it will be translated
- into a 500.
- """
- def _callback(request, **kwargs):
- raise Exception("boo")
- res = JsonResource(self.homeserver)
- res.register_paths(
- "GET", [re.compile("^/_matrix/foo$")], _callback, "test_servlet"
- )
- channel = make_request(
- self.reactor, FakeSite(res, self.reactor), b"GET", b"/_matrix/foo"
- )
- self.assertEqual(channel.result["code"], b"500")
- def test_callback_indirect_exception(self):
- """
- If the web callback raises an uncaught exception in a Deferred, it will
- be translated into a 500.
- """
- def _throw(*args):
- raise Exception("boo")
- def _callback(request, **kwargs):
- d = Deferred()
- d.addCallback(_throw)
- self.reactor.callLater(0.5, d.callback, True)
- return make_deferred_yieldable(d)
- res = JsonResource(self.homeserver)
- res.register_paths(
- "GET", [re.compile("^/_matrix/foo$")], _callback, "test_servlet"
- )
- channel = make_request(
- self.reactor, FakeSite(res, self.reactor), b"GET", b"/_matrix/foo"
- )
- self.assertEqual(channel.result["code"], b"500")
- def test_callback_synapseerror(self):
- """
- If the web callback raises a SynapseError, it returns the appropriate
- status code and message set in it.
- """
- def _callback(request, **kwargs):
- raise SynapseError(403, "Forbidden!!one!", Codes.FORBIDDEN)
- res = JsonResource(self.homeserver)
- res.register_paths(
- "GET", [re.compile("^/_matrix/foo$")], _callback, "test_servlet"
- )
- channel = make_request(
- self.reactor, FakeSite(res, self.reactor), b"GET", b"/_matrix/foo"
- )
- self.assertEqual(channel.result["code"], b"403")
- self.assertEqual(channel.json_body["error"], "Forbidden!!one!")
- self.assertEqual(channel.json_body["errcode"], "M_FORBIDDEN")
- def test_no_handler(self):
- """
- If there is no handler to process the request, Synapse will return 400.
- """
- def _callback(request, **kwargs):
- """
- Not ever actually called!
- """
- self.fail("shouldn't ever get here")
- res = JsonResource(self.homeserver)
- res.register_paths(
- "GET", [re.compile("^/_matrix/foo$")], _callback, "test_servlet"
- )
- channel = make_request(
- self.reactor, FakeSite(res, self.reactor), b"GET", b"/_matrix/foobar"
- )
- self.assertEqual(channel.result["code"], b"400")
- self.assertEqual(channel.json_body["error"], "Unrecognized request")
- self.assertEqual(channel.json_body["errcode"], "M_UNRECOGNIZED")
- def test_head_request(self):
- """
- JsonResource.handler_for_request gives correctly decoded URL args to
- the callback, while Twisted will give the raw bytes of URL query
- arguments.
- """
- def _callback(request, **kwargs):
- return 200, {"result": True}
- res = JsonResource(self.homeserver)
- res.register_paths(
- "GET",
- [re.compile("^/_matrix/foo$")],
- _callback,
- "test_servlet",
- )
- # The path was registered as GET, but this is a HEAD request.
- channel = make_request(
- self.reactor, FakeSite(res, self.reactor), b"HEAD", b"/_matrix/foo"
- )
- self.assertEqual(channel.result["code"], b"200")
- self.assertNotIn("body", channel.result)
- class OptionsResourceTests(unittest.TestCase):
- def setUp(self):
- self.reactor = ThreadedMemoryReactorClock()
- class DummyResource(Resource):
- isLeaf = True
- def render(self, request):
- return request.path
- # Setup a resource with some children.
- self.resource = OptionsResource()
- self.resource.putChild(b"res", DummyResource())
- def _make_request(self, method, path):
- """Create a request from the method/path and return a channel with the response."""
- # Create a site and query for the resource.
- site = SynapseSite(
- "test",
- "site_tag",
- parse_listener_def({"type": "http", "port": 0}),
- self.resource,
- "1.0",
- max_request_body_size=1234,
- reactor=self.reactor,
- )
- # render the request and return the channel
- channel = make_request(self.reactor, site, method, path, shorthand=False)
- return channel
- def test_unknown_options_request(self):
- """An OPTIONS requests to an unknown URL still returns 204 No Content."""
- channel = self._make_request(b"OPTIONS", b"/foo/")
- self.assertEqual(channel.result["code"], b"204")
- self.assertNotIn("body", channel.result)
- # Ensure the correct CORS headers have been added
- self.assertTrue(
- channel.headers.hasHeader(b"Access-Control-Allow-Origin"),
- "has CORS Origin header",
- )
- self.assertTrue(
- channel.headers.hasHeader(b"Access-Control-Allow-Methods"),
- "has CORS Methods header",
- )
- self.assertTrue(
- channel.headers.hasHeader(b"Access-Control-Allow-Headers"),
- "has CORS Headers header",
- )
- def test_known_options_request(self):
- """An OPTIONS requests to an known URL still returns 204 No Content."""
- channel = self._make_request(b"OPTIONS", b"/res/")
- self.assertEqual(channel.result["code"], b"204")
- self.assertNotIn("body", channel.result)
- # Ensure the correct CORS headers have been added
- self.assertTrue(
- channel.headers.hasHeader(b"Access-Control-Allow-Origin"),
- "has CORS Origin header",
- )
- self.assertTrue(
- channel.headers.hasHeader(b"Access-Control-Allow-Methods"),
- "has CORS Methods header",
- )
- self.assertTrue(
- channel.headers.hasHeader(b"Access-Control-Allow-Headers"),
- "has CORS Headers header",
- )
- def test_unknown_request(self):
- """A non-OPTIONS request to an unknown URL should 404."""
- channel = self._make_request(b"GET", b"/foo/")
- self.assertEqual(channel.result["code"], b"404")
- def test_known_request(self):
- """A non-OPTIONS request to an known URL should query the proper resource."""
- channel = self._make_request(b"GET", b"/res/")
- self.assertEqual(channel.result["code"], b"200")
- self.assertEqual(channel.result["body"], b"/res/")
- class WrapHtmlRequestHandlerTests(unittest.TestCase):
- class TestResource(DirectServeHtmlResource):
- callback = None
- async def _async_render_GET(self, request):
- await self.callback(request)
- def setUp(self):
- self.reactor = ThreadedMemoryReactorClock()
- def test_good_response(self):
- async def callback(request):
- request.write(b"response")
- request.finish()
- res = WrapHtmlRequestHandlerTests.TestResource()
- res.callback = callback
- channel = make_request(
- self.reactor, FakeSite(res, self.reactor), b"GET", b"/path"
- )
- self.assertEqual(channel.result["code"], b"200")
- body = channel.result["body"]
- self.assertEqual(body, b"response")
- def test_redirect_exception(self):
- """
- If the callback raises a RedirectException, it is turned into a 30x
- with the right location.
- """
- async def callback(request, **kwargs):
- raise RedirectException(b"/look/an/eagle", 301)
- res = WrapHtmlRequestHandlerTests.TestResource()
- res.callback = callback
- channel = make_request(
- self.reactor, FakeSite(res, self.reactor), b"GET", b"/path"
- )
- self.assertEqual(channel.result["code"], b"301")
- headers = channel.result["headers"]
- location_headers = [v for k, v in headers if k == b"Location"]
- self.assertEqual(location_headers, [b"/look/an/eagle"])
- def test_redirect_exception_with_cookie(self):
- """
- If the callback raises a RedirectException which sets a cookie, that is
- returned too
- """
- async def callback(request, **kwargs):
- e = RedirectException(b"/no/over/there", 304)
- e.cookies.append(b"session=yespls")
- raise e
- res = WrapHtmlRequestHandlerTests.TestResource()
- res.callback = callback
- channel = make_request(
- self.reactor, FakeSite(res, self.reactor), b"GET", b"/path"
- )
- self.assertEqual(channel.result["code"], b"304")
- headers = channel.result["headers"]
- location_headers = [v for k, v in headers if k == b"Location"]
- self.assertEqual(location_headers, [b"/no/over/there"])
- cookies_headers = [v for k, v in headers if k == b"Set-Cookie"]
- self.assertEqual(cookies_headers, [b"session=yespls"])
- def test_head_request(self):
- """A head request should work by being turned into a GET request."""
- async def callback(request):
- request.write(b"response")
- request.finish()
- res = WrapHtmlRequestHandlerTests.TestResource()
- res.callback = callback
- channel = make_request(
- self.reactor, FakeSite(res, self.reactor), b"HEAD", b"/path"
- )
- self.assertEqual(channel.result["code"], b"200")
- self.assertNotIn("body", channel.result)
- class CancellableDirectServeJsonResource(DirectServeJsonResource):
- def __init__(self, clock: Clock):
- super().__init__()
- self.clock = clock
- @cancellable
- async def _async_render_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- await self.clock.sleep(1.0)
- return HTTPStatus.OK, {"result": True}
- async def _async_render_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- await self.clock.sleep(1.0)
- return HTTPStatus.OK, {"result": True}
- class CancellableDirectServeHtmlResource(DirectServeHtmlResource):
- ERROR_TEMPLATE = "{code} {msg}"
- def __init__(self, clock: Clock):
- super().__init__()
- self.clock = clock
- @cancellable
- async def _async_render_GET(self, request: SynapseRequest) -> Tuple[int, bytes]:
- await self.clock.sleep(1.0)
- return HTTPStatus.OK, b"ok"
- async def _async_render_POST(self, request: SynapseRequest) -> Tuple[int, bytes]:
- await self.clock.sleep(1.0)
- return HTTPStatus.OK, b"ok"
- class DirectServeJsonResourceCancellationTests(EndpointCancellationTestHelperMixin):
- """Tests for `DirectServeJsonResource` cancellation."""
- def setUp(self):
- self.reactor = ThreadedMemoryReactorClock()
- self.clock = Clock(self.reactor)
- self.resource = CancellableDirectServeJsonResource(self.clock)
- self.site = FakeSite(self.resource, self.reactor)
- def test_cancellable_disconnect(self) -> None:
- """Test that handlers with the `@cancellable` flag can be cancelled."""
- channel = make_request(
- self.reactor, self.site, "GET", "/sleep", await_result=False
- )
- self._test_disconnect(
- self.reactor,
- channel,
- expect_cancellation=True,
- expected_body={"error": "Request cancelled", "errcode": Codes.UNKNOWN},
- )
- def test_uncancellable_disconnect(self) -> None:
- """Test that handlers without the `@cancellable` flag cannot be cancelled."""
- channel = make_request(
- self.reactor, self.site, "POST", "/sleep", await_result=False
- )
- self._test_disconnect(
- self.reactor,
- channel,
- expect_cancellation=False,
- expected_body={"result": True},
- )
- class DirectServeHtmlResourceCancellationTests(EndpointCancellationTestHelperMixin):
- """Tests for `DirectServeHtmlResource` cancellation."""
- def setUp(self):
- self.reactor = ThreadedMemoryReactorClock()
- self.clock = Clock(self.reactor)
- self.resource = CancellableDirectServeHtmlResource(self.clock)
- self.site = FakeSite(self.resource, self.reactor)
- def test_cancellable_disconnect(self) -> None:
- """Test that handlers with the `@cancellable` flag can be cancelled."""
- channel = make_request(
- self.reactor, self.site, "GET", "/sleep", await_result=False
- )
- self._test_disconnect(
- self.reactor,
- channel,
- expect_cancellation=True,
- expected_body=b"499 Request cancelled",
- )
- def test_uncancellable_disconnect(self) -> None:
- """Test that handlers without the `@cancellable` flag cannot be cancelled."""
- channel = make_request(
- self.reactor, self.site, "POST", "/sleep", await_result=False
- )
- self._test_disconnect(
- self.reactor, channel, expect_cancellation=False, expected_body=b"ok"
- )
|