almalinux/pungi
14
1
Fork 0
Code Issues Pull Requests Releases Activity

Merge #443 config: Don't abort on deprecated options

Browse Source
This commit is contained in:
Dennis Gilmore 2016-10-20 20:26:17 +00:00
commit 18128623b4
4 changed files with 41 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
bin/pungi-config-validate
View File

@ -65,8 +65,9 @@ def run(config, topdir, has_old):
conf.load_from_file(config)
errors = pungi.checks.validate(conf)
if errors:
for error in errors:
warnings = list(pungi.checks.report_removed(conf))
if errors or warnings:
for error in errors + warnings:
print(error)
sys.exit(1)

2
bin/pungi-koji
View File

@ -184,6 +184,8 @@ def main():
sys.exit(1)
pungi.checks.check_umask(logger)
errors = pungi.checks.validate(conf)
for warning in pungi.checks.report_removed(conf):
print >>sys.stderr, warning
if errors:
for error in errors:
print >>sys.stderr, error

70
pungi/checks.py
View File

@ -180,24 +180,29 @@ def validate(config):
'regex': (str, unicode)})
errors = []
for error in validator.iter_errors(config):
if isinstance(error, ConfigDeprecation):
errors.append(DEPRECATED.format('.'.join(error.path), error.message))
if not error.path and error.validator == 'additionalProperties':
allowed_keys = set(error.schema['properties'].keys())
used_keys = set(error.instance.keys())
for key in used_keys - allowed_keys:
suggestion = _get_suggestion(key, allowed_keys)
if suggestion:
errors.append(UNKNOWN_SUGGEST.format(key, suggestion))
else:
errors.append(UNKNOWN.format(key))
else:
if not error.path and error.validator == 'additionalProperties':
allowed_keys = set(error.schema['properties'].keys())
used_keys = set(error.instance.keys())
for key in used_keys - allowed_keys:
suggestion = _get_suggestion(key, allowed_keys)
if suggestion:
errors.append(UNKNOWN_SUGGEST.format(key, suggestion))
else:
errors.append(UNKNOWN.format(key))
else:
errors.append('Failed validation in %s: %s' % (
'.'.join([str(x) for x in error.path]), error.message))
errors.append('Failed validation in %s: %s' % (
'.'.join([str(x) for x in error.path]), error.message))
return errors + _validate_requires(schema, config, CONFIG_DEPS)
def report_removed(config):
schema = _make_schema()
for key in config:
msg = schema['properties'].get(key, {}).get('deprecated')
if msg:
yield REMOVED.format(key, msg)
def _get_suggestion(desired, names):
"""Find a value in ``names`` that is the closest match for ``desired``.
@ -214,11 +219,11 @@ def _get_suggestion(desired, names):
return closest
CONFLICTS = 'Config option {0}={1} conflicts with option {2}.'
REQUIRES = 'Config option {0}={1} requires {2} which is not set.'
DEPRECATED = 'Deprecated config option: {0}; {1}.'
UNKNOWN = 'Unrecognized config option: {0}.'
UNKNOWN_SUGGEST = 'Unrecognized config option: {0}. Did you mean {1}?'
CONFLICTS = 'ERROR: Config option {0}={1} conflicts with option {2}.'
REQUIRES = 'ERROR: Config option {0}={1} requires {2} which is not set.'
REMOVED = 'WARNING: Config option {0} was removed and has no effect; {1}.'
UNKNOWN = 'ERROR: Unrecognized config option: {0}.'
UNKNOWN_SUGGEST = 'ERROR: Unrecognized config option: {0}. Did you mean {1}?'
def _extend_with_default(validator_class):
@ -237,12 +242,6 @@ def _extend_with_default(validator_class):
for error in validate_properties(validator, properties, instance, schema):
yield error
def error_on_deprecated(validator, properties, instance, schema):
"""Unconditionally raise deprecation error if encountered."""
yield ConfigDeprecation(
'use %s instead' % properties
)
def validate_regex_type(validator, properties, instance, schema):
"""
Extend standard type validation to check correctness in regular
@ -262,15 +261,10 @@ def _extend_with_default(validator_class):
return jsonschema.validators.extend(
validator_class, {"properties": set_defaults,
"deprecated": error_on_deprecated,
"type": validate_regex_type},
)
class ConfigDeprecation(jsonschema.exceptions.ValidationError):
pass
def _make_schema():
return {
"$schema": "http://json-schema.org/draft-04/schema#",
@ -588,7 +582,7 @@ def _make_schema():
"default": True,
},
"keep_original_comps": {
"deprecated": "no <groups> tag for respective variant in variants XML"
"deprecated": "remove <groups> tag from respective variant in variants XML"
},
"link_type": {
@ -822,25 +816,25 @@ def _make_schema():
# Deprecated options
"multilib_arches": {
"deprecated": "multilib"
"deprecated": "use multilib instead"
},
"multilib_methods": {
"deprecated": "multilib"
"deprecated": "use multilib instead"
},
"additional_packages_multiarch": {
"deprecated": "multilib_whitelist"
"deprecated": "use multilib_whitelist instead"
},
"filter_packages_multiarch": {
"deprecated": "multilib_blacklist"
"deprecated": "use multilib_blacklist instead"
},
"buildinstall_upgrade_image": {
"deprecated": "lorax_options"
"deprecated": "use lorax_options instead"
},
"pkgset_koji_path_prefix": {
"deprecated": "koji_profile",
"deprecated": "use koji_profile instead",
},
"pkgset_koji_url": {
"deprecated": "koji_profile",
"deprecated": "use koji_profile instead",
},
},

6
tests/test_config.py
View File

@ -194,9 +194,11 @@ class BuildinstallConfigTestCase(unittest.TestCase):
buildinstall_upgrade_image=True,
)
self.assertItemsEqual(checks.validate(cfg), [])
self.assertItemsEqual(
checks.validate(cfg),
[checks.DEPRECATED.format('buildinstall_upgrade_image', 'use lorax_options instead')]
checks.report_removed(cfg),
[checks.REMOVED.format('buildinstall_upgrade_image', 'use lorax_options instead')]
)