Skip to content

Add Better error message for lists in config file #6200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 9, 2019
Merged

Add Better error message for lists in config file #6200

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f2a1863
Add Better errror message for lists in config file
saadmk11 Sep 21, 2019
3278ca8
msg regex moved to method
saadmk11 Sep 24, 2019
a6c186b
set regex only for msg
saadmk11 Sep 25, 2019
e8b3edf
covert staticmethod to instance method
saadmk11 Sep 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion readthedocs/config/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,11 @@ class InvalidConfig(ConfigError):
message_template = 'Invalid "{key}": {error}'

def __init__(self, key, code, error_message, source_file=None):
self.key = key
# Checks for patterns similar to `python.install.0.requirements`
# if matched change to `python.install[0].requirements` using backreference.
self.key = re.sub(
r'^(python\.install)(\.)(\d+)(\.\w+)$', r'\1[\3]\4', key
)
self.code = code
self.source_file = source_file
message = self.message_template.format(
Expand Down
14 changes: 7 additions & 7 deletions readthedocs/config/tests/test_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1062,7 +1062,7 @@ def test_python_install_method_check_invalid(self, value, tmpdir):
)
with raises(InvalidConfig) as excinfo:
build.validate()
assert excinfo.value.key == 'python.install.0.method'
assert excinfo.value.key == 'python.install[0].method'

def test_python_install_requirements_check_valid(self, tmpdir):
apply_fs(tmpdir, {'requirements.txt': ''})
Expand Down Expand Up @@ -1096,7 +1096,7 @@ def test_python_install_requirements_does_not_allow_null(self, tmpdir):
)
with raises(InvalidConfig) as excinfo:
build.validate()
assert excinfo.value.key == 'python.install.0.requirements'
assert excinfo.value.key == 'python.install[0].requirements'

def test_python_install_requirements_does_not_allow_empty_string(self, tmpdir):
build = self.get_build_config(
Expand All @@ -1112,7 +1112,7 @@ def test_python_install_requirements_does_not_allow_empty_string(self, tmpdir):
)
with raises(InvalidConfig) as excinfo:
build.validate()
assert excinfo.value.key == 'python.install.0.requirements'
assert excinfo.value.key == 'python.install[0].requirements'

def test_python_install_requirements_ignores_default(self, tmpdir):
apply_fs(tmpdir, {'requirements.txt': ''})
Expand Down Expand Up @@ -1157,7 +1157,7 @@ def test_python_install_requirements_check_invalid_types(self, value, tmpdir):
)
with raises(InvalidConfig) as excinfo:
build.validate()
assert excinfo.value.key == 'python.install.0.requirements'
assert excinfo.value.key == 'python.install[0].requirements'

def test_python_install_path_is_required(self, tmpdir):
build = self.get_build_config(
Expand Down Expand Up @@ -1307,7 +1307,7 @@ def test_python_install_extra_requirements_and_setuptools(self, tmpdir):
)
with raises(InvalidConfig) as excinfo:
build.validate()
assert excinfo.value.key == 'python.install.0.extra_requirements'
assert excinfo.value.key == 'python.install[0].extra_requirements'

@pytest.mark.parametrize('value', [2, 'invalid', {}, '', None])
def test_python_install_extra_requirements_check_type(self, value, tmpdir):
Expand All @@ -1325,7 +1325,7 @@ def test_python_install_extra_requirements_check_type(self, value, tmpdir):
)
with raises(InvalidConfig) as excinfo:
build.validate()
assert excinfo.value.key == 'python.install.0.extra_requirements'
assert excinfo.value.key == 'python.install[0].extra_requirements'

def test_python_install_extra_requirements_allow_empty(self, tmpdir):
build = self.get_build_config(
Expand Down Expand Up @@ -1852,7 +1852,7 @@ def test_submodules_recursive_explicit_default(self):
}]
}
},
'python.install.1.invalid'
'python.install[1].invalid'
)
])
def test_strict_validation(self, value, key):
Expand Down