Merge pull request #3758 from matrix-org/erikj/admin_contact

Change admin_uri to admin_contact in config and errors
This commit is contained in:
Erik Johnston 2018-08-24 17:15:32 +01:00 committed by GitHub
commit 9fbaed325f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 14 additions and 13 deletions

1
changelog.d/3758.bugfix Normal file
View File

@ -0,0 +1 @@
Fix 'admin_uri' config variable and error parameter to be 'admin_contact' to match the spec.

View File

@ -793,7 +793,7 @@ class Auth(object):
raise ResourceLimitError( raise ResourceLimitError(
403, self.hs.config.hs_disabled_message, 403, self.hs.config.hs_disabled_message,
errcode=Codes.RESOURCE_LIMIT_EXCEEDED, errcode=Codes.RESOURCE_LIMIT_EXCEEDED,
admin_uri=self.hs.config.admin_uri, admin_contact=self.hs.config.admin_contact,
limit_type=self.hs.config.hs_disabled_limit_type limit_type=self.hs.config.hs_disabled_limit_type
) )
if self.hs.config.limit_usage_by_mau is True: if self.hs.config.limit_usage_by_mau is True:
@ -812,7 +812,7 @@ class Auth(object):
raise ResourceLimitError( raise ResourceLimitError(
403, "Monthly Active User Limit Exceeded", 403, "Monthly Active User Limit Exceeded",
admin_uri=self.hs.config.admin_uri, admin_contact=self.hs.config.admin_contact,
errcode=Codes.RESOURCE_LIMIT_EXCEEDED, errcode=Codes.RESOURCE_LIMIT_EXCEEDED,
limit_type="monthly_active_user" limit_type="monthly_active_user"
) )

View File

@ -239,10 +239,10 @@ class ResourceLimitError(SynapseError):
def __init__( def __init__(
self, code, msg, self, code, msg,
errcode=Codes.RESOURCE_LIMIT_EXCEEDED, errcode=Codes.RESOURCE_LIMIT_EXCEEDED,
admin_uri=None, admin_contact=None,
limit_type=None, limit_type=None,
): ):
self.admin_uri = admin_uri self.admin_contact = admin_contact
self.limit_type = limit_type self.limit_type = limit_type
super(ResourceLimitError, self).__init__(code, msg, errcode=errcode) super(ResourceLimitError, self).__init__(code, msg, errcode=errcode)
@ -250,7 +250,7 @@ class ResourceLimitError(SynapseError):
return cs_error( return cs_error(
self.msg, self.msg,
self.errcode, self.errcode,
admin_uri=self.admin_uri, admin_contact=self.admin_contact,
limit_type=self.limit_type limit_type=self.limit_type
) )

View File

@ -93,7 +93,7 @@ class ServerConfig(Config):
# Admin uri to direct users at should their instance become blocked # Admin uri to direct users at should their instance become blocked
# due to resource constraints # due to resource constraints
self.admin_uri = config.get("admin_uri", None) self.admin_contact = config.get("admin_contact", None)
# FIXME: federation_domain_whitelist needs sytests # FIXME: federation_domain_whitelist needs sytests
self.federation_domain_whitelist = None self.federation_domain_whitelist = None
@ -357,7 +357,7 @@ class ServerConfig(Config):
# Homeserver blocking # Homeserver blocking
# #
# How to reach the server admin, used in ResourceLimitError # How to reach the server admin, used in ResourceLimitError
# admin_uri: 'mailto:admin@server.com' # admin_contact: 'mailto:admin@server.com'
# #
# Global block config # Global block config
# #

View File

@ -118,7 +118,7 @@ class ResourceLimitsServerNotices(object):
'body': event_content, 'body': event_content,
'msgtype': ServerNoticeMsgType, 'msgtype': ServerNoticeMsgType,
'server_notice_type': ServerNoticeLimitReached, 'server_notice_type': ServerNoticeLimitReached,
'admin_uri': self._config.admin_uri, 'admin_contact': self._config.admin_contact,
'limit_type': event_limit_type 'limit_type': event_limit_type
} }
event = yield self._server_notices_manager.send_notice( event = yield self._server_notices_manager.send_notice(

View File

@ -457,7 +457,7 @@ class AuthTestCase(unittest.TestCase):
with self.assertRaises(ResourceLimitError) as e: with self.assertRaises(ResourceLimitError) as e:
yield self.auth.check_auth_blocking() yield self.auth.check_auth_blocking()
self.assertEquals(e.exception.admin_uri, self.hs.config.admin_uri) self.assertEquals(e.exception.admin_contact, self.hs.config.admin_contact)
self.assertEquals(e.exception.errcode, Codes.RESOURCE_LIMIT_EXCEEDED) self.assertEquals(e.exception.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
self.assertEquals(e.exception.code, 403) self.assertEquals(e.exception.code, 403)
@ -473,7 +473,7 @@ class AuthTestCase(unittest.TestCase):
self.hs.config.hs_disabled_message = "Reason for being disabled" self.hs.config.hs_disabled_message = "Reason for being disabled"
with self.assertRaises(ResourceLimitError) as e: with self.assertRaises(ResourceLimitError) as e:
yield self.auth.check_auth_blocking() yield self.auth.check_auth_blocking()
self.assertEquals(e.exception.admin_uri, self.hs.config.admin_uri) self.assertEquals(e.exception.admin_contact, self.hs.config.admin_contact)
self.assertEquals(e.exception.errcode, Codes.RESOURCE_LIMIT_EXCEEDED) self.assertEquals(e.exception.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
self.assertEquals(e.exception.code, 403) self.assertEquals(e.exception.code, 403)

View File

@ -56,7 +56,7 @@ class TestResourceLimitsServerNotices(unittest.TestCase):
) )
self._rlsn._store.add_tag_to_room = Mock() self._rlsn._store.add_tag_to_room = Mock()
self._rlsn._store.get_tags_for_room = Mock(return_value={}) self._rlsn._store.get_tags_for_room = Mock(return_value={})
self.hs.config.admin_uri = "mailto:user@test.com" self.hs.config.admin_contact = "mailto:user@test.com"
@defer.inlineCallbacks @defer.inlineCallbacks
def test_maybe_send_server_notice_to_user_flag_off(self): def test_maybe_send_server_notice_to_user_flag_off(self):
@ -173,7 +173,7 @@ class TestResourceLimitsServerNoticesWithRealRooms(unittest.TestCase):
self.user_id = "@user_id:test" self.user_id = "@user_id:test"
self.hs.config.admin_uri = "mailto:user@test.com" self.hs.config.admin_contact = "mailto:user@test.com"
@defer.inlineCallbacks @defer.inlineCallbacks
def test_server_notice_only_sent_once(self): def test_server_notice_only_sent_once(self):

View File

@ -142,7 +142,7 @@ def setup_test_homeserver(
config.hs_disabled_limit_type = "" config.hs_disabled_limit_type = ""
config.max_mau_value = 50 config.max_mau_value = 50
config.mau_limits_reserved_threepids = [] config.mau_limits_reserved_threepids = []
config.admin_uri = None config.admin_contact = None
# we need a sane default_room_version, otherwise attempts to create rooms will # we need a sane default_room_version, otherwise attempts to create rooms will
# fail. # fail.