Fix RoomDirectoryFederationTests and make them actually run (#8998)

The `RoomDirectoryFederationTests` tests were not being run unless explicitly called as an `__init__.py` file was not present in `tests/federation/transport/`. Thus the folder was not a python module, and `trial` did not look inside for any test cases to run. This was found while working on #6739.

This PR adds a `__init__.py` and also fixes the test in a couple ways:

- Switch to subclassing `unittest.FederatingHomeserverTestCase` instead, which sets up federation endpoints for us.
- Supply a `federation_auth_origin` to `make_request` in order to more act like the request is coming from another server, instead of just an unauthenicated client requesting a federation endpoint.

I found that the second point makes no difference to the test passing, but felt like the right thing to do if we're testing over federation.
This commit is contained in:
Andrew Morgan 2020-12-30 19:27:32 +00:00 committed by GitHub
parent b7c580e333
commit 168ba00d01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 21 deletions

1
changelog.d/8998.misc Normal file
View File

@ -0,0 +1 @@
Fix `tests.federation.transport.RoomDirectoryFederationTests` and ensure it runs in CI.

View File

View File

@ -1,5 +1,5 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# Copyright 2019 The Matrix.org Foundation C.I.C. # Copyright 2020 The Matrix.org Foundation C.I.C.
# #
# Licensed under the Apache License, Version 2.0 (the "License"); # Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License. # you may not use this file except in compliance with the License.
@ -13,34 +13,31 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
from twisted.internet import defer
from synapse.config.ratelimiting import FederationRateLimitConfig
from synapse.federation.transport import server
from synapse.util.ratelimitutils import FederationRateLimiter
from tests import unittest from tests import unittest
from tests.unittest import override_config from tests.unittest import override_config
class RoomDirectoryFederationTests(unittest.HomeserverTestCase): class RoomDirectoryFederationTests(unittest.FederatingHomeserverTestCase):
def prepare(self, reactor, clock, homeserver):
class Authenticator:
def authenticate_request(self, request, content):
return defer.succeed("otherserver.nottld")
ratelimiter = FederationRateLimiter(clock, FederationRateLimitConfig())
server.register_servlets(
homeserver, self.resource, Authenticator(), ratelimiter
)
@override_config({"allow_public_rooms_over_federation": False}) @override_config({"allow_public_rooms_over_federation": False})
def test_blocked_public_room_list_over_federation(self): def test_blocked_public_room_list_over_federation(self):
channel = self.make_request("GET", "/_matrix/federation/v1/publicRooms") """Test that unauthenticated requests to the public rooms directory 403 when
allow_public_rooms_over_federation is False.
"""
channel = self.make_request(
"GET",
"/_matrix/federation/v1/publicRooms",
federation_auth_origin=b"example.com",
)
self.assertEquals(403, channel.code) self.assertEquals(403, channel.code)
@override_config({"allow_public_rooms_over_federation": True}) @override_config({"allow_public_rooms_over_federation": True})
def test_open_public_room_list_over_federation(self): def test_open_public_room_list_over_federation(self):
channel = self.make_request("GET", "/_matrix/federation/v1/publicRooms") """Test that unauthenticated requests to the public rooms directory 200 when
allow_public_rooms_over_federation is True.
"""
channel = self.make_request(
"GET",
"/_matrix/federation/v1/publicRooms",
federation_auth_origin=b"example.com",
)
self.assertEquals(200, channel.code) self.assertEquals(200, channel.code)