Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 13bc1e0

Browse files
committed
Use a regular HomeServerConfig object for unit tests
Rather than using a Mock for the homeserver config, use a genuine HomeServerConfig object. This makes for a more realistic test, and means that we don't have to keep remembering to add things to the mock config every time we add a new config setting.
1 parent 053c50b commit 13bc1e0

File tree

3 files changed

+25
-13
lines changed

3 files changed

+25
-13
lines changed

synapse/config/_base.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,10 @@ def read_config_files(self, config_files, keys_directory=None, generate_keys=Fal
405405
self.invoke_all("generate_files", config)
406406
return
407407

408-
self.invoke_all("read_config", config)
408+
self.parse_config_dict(config)
409+
410+
def parse_config_dict(self, config_dict):
411+
self.invoke_all("read_config", config_dict)
409412

410413

411414
def find_config_files(search_paths):

synapse/config/key.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,12 @@
3838
class KeyConfig(Config):
3939

4040
def read_config(self, config):
41-
self.signing_key = self.read_signing_key(config["signing_key_path"])
41+
# the signing key can be specified inline or in a separate file
42+
if "signing_key" in config:
43+
self.signing_key = read_signing_keys([config["signing_key"]])
44+
else:
45+
self.signing_key = self.read_signing_key(config["signing_key_path"])
46+
4247
self.old_signing_keys = self.read_old_signing_keys(
4348
config.get("old_signing_keys", {})
4449
)

tests/utils.py

+15-11
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
from synapse.api.constants import EventTypes, RoomVersions
3030
from synapse.api.errors import CodeMessageException, cs_error
31-
from synapse.config.server import ServerConfig
31+
from synapse.config.homeserver import HomeServerConfig
3232
from synapse.federation.transport import server as federation_server
3333
from synapse.http.server import HttpServer
3434
from synapse.server import HomeServer
@@ -111,14 +111,25 @@ def default_config(name):
111111
"""
112112
Create a reasonable test config.
113113
"""
114-
config = Mock()
115-
config.signing_key = [MockKey()]
114+
config_dict = {
115+
"server_name": name,
116+
"media_store_path": "media",
117+
"uploads_path": "uploads",
118+
119+
# the test signing key is just an arbitrary ed25519 key to keep the config
120+
# parser happy
121+
"signing_key": "ed25519 a_lPym qvioDNmfExFBRPgdTU+wtFYKq4JfwFRv7sYVgWvmgJg",
122+
}
123+
124+
config = HomeServerConfig()
125+
config.parse_config_dict(config_dict)
126+
127+
# TODO: move this stuff into config_dict or get rid of it
116128
config.event_cache_size = 1
117129
config.enable_registration = True
118130
config.enable_registration_captcha = False
119131
config.macaroon_secret_key = "not even a little secret"
120132
config.expire_access_token = False
121-
config.server_name = name
122133
config.trusted_third_party_id_servers = []
123134
config.room_invite_state_types = []
124135
config.password_providers = []
@@ -176,13 +187,6 @@ def default_config(name):
176187
# background, which upsets the test runner.
177188
config.update_user_directory = False
178189

179-
def is_threepid_reserved(threepid):
180-
return ServerConfig.is_threepid_reserved(
181-
config.mau_limits_reserved_threepids, threepid
182-
)
183-
184-
config.is_threepid_reserved.side_effect = is_threepid_reserved
185-
186190
return config
187191

188192

0 commit comments

Comments
 (0)