ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add some type checking of configs 

Before, the types were not checked and just expected. The old behavior
would cause lots of tracebacks, or, much worse, convert things like:
```
{
     "target_overrides": {
        "*": {
		"target.macros_add": "CONFIG_GPIO_AS_PINRESET"
        }
     }
}
```
into a definition of each of the letters as macros that expand to
nothing, causing massive compilation problems.

I resolved this by adding some type checking to the config data. Now
there is a type check for most of the fields within a library and
application configurations.
pull/4000/head
Jimmy Brisson 2017-03-22 16:55:07 -05:00
parent 75f6f2db30
commit d5637bb785
1 changed files with 41 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
tools/config.py
View File

@ -332,6 +332,12 @@ def _process_macros(mlist, macros, unit_name, unit_kind):
macros[macro.macro_name] = macro macros[macro.macro_name] = macro
def check_dict_types(dict, type_dict, dict_loc):
for key, value in dict.iteritems():
if not isinstance(value, type_dict[key]):
raise ConfigException("The value of %s.%s is not of type %s" %
(dict_loc, key, type_dict[key].__name__))
Region = namedtuple("Region", "name start size active filename") Region = namedtuple("Region", "name start size active filename")
class Config(object): class Config(object):
@ -342,14 +348,14 @@ class Config(object):
__mbed_app_config_name = "mbed_app.json" __mbed_app_config_name = "mbed_app.json"
__mbed_lib_config_name = "mbed_lib.json" __mbed_lib_config_name = "mbed_lib.json"
# Allowed keys in configuration dictionaries # Allowed keys in configuration dictionaries, and their types
# (targets can have any kind of keys, so this validation is not applicable # (targets can have any kind of keys, so this validation is not applicable
# to them) # to them)
__allowed_keys = { __allowed_keys = {
"library": set(["name", "config", "target_overrides", "macros", "library": {"name": str, "config": dict, "target_overrides": dict,
"__config_path"]), "macros": list, "__config_path": str},
"application": set(["config", "target_overrides", "application": {"config": dict, "target_overrides": dict,
"macros", "__config_path"]) "macros": list, "__config_path": str}
} }
__unused_overrides = set(["target.bootloader_img", "target.restrict_size"]) __unused_overrides = set(["target.bootloader_img", "target.restrict_size"])
@ -398,11 +404,13 @@ class Config(object):
# Check the keys in the application configuration data # Check the keys in the application configuration data
unknown_keys = set(self.app_config_data.keys()) - \ unknown_keys = set(self.app_config_data.keys()) - \
self.__allowed_keys["application"] set(self.__allowed_keys["application"].keys())
if unknown_keys: if unknown_keys:
raise ConfigException("Unknown key(s) '%s' in %s" % raise ConfigException("Unknown key(s) '%s' in %s" %
(",".join(unknown_keys), (",".join(unknown_keys),
self.__mbed_app_config_name)) self.__mbed_app_config_name))
check_dict_types(self.app_config_data, self.__allowed_keys["application"],
"app-config")
# Update the list of targets with the ones defined in the application # Update the list of targets with the ones defined in the application
# config, if applicable # config, if applicable
self.lib_config_data = {} self.lib_config_data = {}
@ -542,19 +550,34 @@ class Config(object):
# Parse out cumulative overrides # Parse out cumulative overrides
for attr, cumulatives in self.cumulative_overrides.iteritems(): for attr, cumulatives in self.cumulative_overrides.iteritems():
if 'target.'+attr in overrides: if 'target.'+attr in overrides:
cumulatives.strict_cumulative_overrides( key = 'target.' + attr
overrides['target.'+attr]) if not isinstance(overrides[key], list):
del overrides['target.'+attr] raise ConfigException(
"The value of %s.%s is not of type %s" %
(unit_name, "target_overrides." + key,
"list"))
cumulatives.strict_cumulative_overrides(overrides[key])
del overrides[key]
if 'target.'+attr+'_add' in overrides: if 'target.'+attr+'_add' in overrides:
cumulatives.add_cumulative_overrides( key = 'target.' + attr + "_add"
overrides['target.'+attr+'_add']) if not isinstance(overrides[key], list):
del overrides['target.'+attr+'_add'] raise ConfigException(
"The value of %s.%s is not of type %s" %
(unit_name, "target_overrides." + key,
"list"))
cumulatives.add_cumulative_overrides(overrides[key])
del overrides[key]
if 'target.'+attr+'_remove' in overrides: if 'target.'+attr+'_remove' in overrides:
cumulatives.remove_cumulative_overrides( key = 'target.' + attr + "_remove"
overrides['target.'+attr+'_remove']) if not isinstance(overrides[key], list):
del overrides['target.'+attr+'_remove'] raise ConfigException(
"The value of %s.%s is not of type %s" %
(unit_name, "target_overrides." + key,
"list"))
cumulatives.remove_cumulative_overrides(overrides[key])
del overrides[key]
# Consider the others as overrides # Consider the others as overrides
for name, val in overrides.items(): for name, val in overrides.items():
@ -639,10 +662,12 @@ class Config(object):
""" """
all_params, macros = {}, {} all_params, macros = {}, {}
for lib_name, lib_data in self.lib_config_data.items(): for lib_name, lib_data in self.lib_config_data.items():
unknown_keys = set(lib_data.keys()) - self.__allowed_keys["library"] unknown_keys = (set(lib_data.keys()) -
set(self.__allowed_keys["library"].keys()))
if unknown_keys: if unknown_keys:
raise ConfigException("Unknown key(s) '%s' in %s" % raise ConfigException("Unknown key(s) '%s' in %s" %
(",".join(unknown_keys), lib_name)) (",".join(unknown_keys), lib_name))
check_dict_types(lib_data, self.__allowed_keys["library"], lib_name)
all_params.update(self._process_config_and_overrides(lib_data, {}, all_params.update(self._process_config_and_overrides(lib_data, {},
lib_name, lib_name,
"library")) "library"))