0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-14 07:53:47 +01:00

Fix validate_config on nested objects (#9054)

This commit is contained in:
Richard van der Hoff 2021-01-08 14:23:04 +00:00 committed by GitHub
parent fa5f5cbc74
commit d32870ffa5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 55 additions and 1 deletions

1
changelog.d/9054.bugfix Normal file
View file

@ -0,0 +1 @@
Fix a minor bug which could cause confusing error messages from invalid configurations.

View file

@ -56,7 +56,7 @@ def json_error_to_config_error(
""" """
# copy `config_path` before modifying it. # copy `config_path` before modifying it.
path = list(config_path) path = list(config_path)
for p in list(e.path): for p in list(e.absolute_path):
if isinstance(p, int): if isinstance(p, int):
path.append("<item %i>" % p) path.append("<item %i>" % p)
else: else:

53
tests/config/test_util.py Normal file
View file

@ -0,0 +1,53 @@
# -*- coding: utf-8 -*-
# Copyright 2021 The Matrix.org Foundation C.I.C.
#
# 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.
from synapse.config import ConfigError
from synapse.config._util import validate_config
from tests.unittest import TestCase
class ValidateConfigTestCase(TestCase):
"""Test cases for synapse.config._util.validate_config"""
def test_bad_object_in_array(self):
"""malformed objects within an array should be validated correctly"""
# consider a structure:
#
# array_of_objs:
# - r: 1
# foo: 2
#
# - r: 2
# bar: 3
#
# ... where each entry must contain an "r": check that the path
# to the required item is correclty reported.
schema = {
"type": "object",
"properties": {
"array_of_objs": {
"type": "array",
"items": {"type": "object", "required": ["r"]},
},
},
}
with self.assertRaises(ConfigError) as c:
validate_config(schema, {"array_of_objs": [{}]}, ("base",))
self.assertEqual(c.exception.path, ["base", "array_of_objs", "<item 0>"])