vyos/vyos-build
1
0
Fork 0
mirror of https://github.com/vyos/vyos-build.git synced 2025-10-01 20:28:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

build: T3664: use explicit defaults argument in the dict merging function

Browse Source 
to make it clear what is merged into what
This commit is contained in:
Daniil Baturin 2024-05-09 11:12:24 +01:00
parent 24a320e337
commit 7656acd57d
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
scripts/image-build/build-vyos-image
View File

@ -21,6 +21,7 @@
import re import re
import os import os
import sys import sys
import copy
import uuid import uuid
import glob import glob
import json import json
@ -138,21 +139,22 @@ def get_validator(optdict, name):
except KeyError: except KeyError:
return None return None
def merge_dicts(source, destination, skip_none=False): def merge_defaults(source, defaults={}, skip_none=False):
""" Merge two dictionaries and return a new dict which has the merged key/value pairs. """ Merge a dict with values from a defaults dict.
Merging logic is as follows: Merging logic is as follows:
Sub-dicts are merged. Sub-dicts are merged.
List values are combined. List values are combined.
Scalar values are set to those from the source dict. Scalar values are set to those from the source dict,
if they exist there.
""" """
from copy import deepcopy from copy import deepcopy
tmp = deepcopy(destination) tmp = deepcopy(defaults)
for key, value in source.items(): for key, value in source.items():
if key not in tmp: if key not in tmp:
tmp[key] = value tmp[key] = value
elif isinstance(source[key], dict): elif isinstance(source[key], dict):
tmp[key] = merge_dicts(source[key], tmp[key]) tmp[key] = merge_defaults(source[key], tmp[key])
elif isinstance(source[key], list): elif isinstance(source[key], list):
tmp[key] = source[key] + tmp[key] tmp[key] = source[key] + tmp[key]
elif not skip_none or source[key] is not None: elif not skip_none or source[key] is not None:
@ -245,7 +247,7 @@ if __name__ == "__main__":
sys.exit(1) sys.exit(1)
## Try to get correct architecture and build type from build flavor and CLI arguments ## Try to get correct architecture and build type from build flavor and CLI arguments
pre_build_config = merge_dicts({}, build_defaults) pre_build_config = copy.deepcopy(build_defaults)
flavor_config = {} flavor_config = {}
build_flavor = args["build_flavor"] build_flavor = args["build_flavor"]
@ -253,7 +255,7 @@ if __name__ == "__main__":
toml_flavor_file = make_toml_path(flavor_dir, args["build_flavor"]) toml_flavor_file = make_toml_path(flavor_dir, args["build_flavor"])
with open(toml_flavor_file, 'rb') as f: with open(toml_flavor_file, 'rb') as f:
flavor_config = tomli.load(f) flavor_config = tomli.load(f)
pre_build_config = merge_dicts(flavor_config, pre_build_config) pre_build_config = merge_defaults(flavor_config, defaults=pre_build_config)
except FileNotFoundError: except FileNotFoundError:
print(f"E: Flavor '{build_flavor}' does not exist") print(f"E: Flavor '{build_flavor}' does not exist")
sys.exit(1) sys.exit(1)
@ -262,7 +264,7 @@ if __name__ == "__main__":
sys.exit(1) sys.exit(1)
## Combine configs args > flavor > defaults ## Combine configs args > flavor > defaults
pre_build_config = merge_dicts(args, pre_build_config, skip_none=True) pre_build_config = merge_defaults(args, defaults=pre_build_config, skip_none=True)
# Some fixup for mirror settings. # Some fixup for mirror settings.
# The idea is: if --debian-mirror is specified but --pbuilder-debian-mirror is not, # The idea is: if --debian-mirror is specified but --pbuilder-debian-mirror is not,
@ -294,20 +296,20 @@ if __name__ == "__main__":
args['pbuilder_config'] = os.path.join(defaults.BUILD_DIR, defaults.PBUILDER_CONFIG) args['pbuilder_config'] = os.path.join(defaults.BUILD_DIR, defaults.PBUILDER_CONFIG)
## Combine the arguments with non-configurable defaults ## Combine the arguments with non-configurable defaults
build_config = merge_dicts({}, build_defaults) build_config = copy.deepcopy(build_defaults)
## Load correct mix-ins ## Load correct mix-ins
with open(make_toml_path(defaults.BUILD_TYPES_DIR, pre_build_config["build_type"]), 'rb') as f: with open(make_toml_path(defaults.BUILD_TYPES_DIR, pre_build_config["build_type"]), 'rb') as f:
build_type_config = tomli.load(f) build_type_config = tomli.load(f)
build_config = merge_dicts(build_type_config, build_config) build_config = merge_defaults(build_type_config, defaults=build_config)
with open(make_toml_path(defaults.BUILD_ARCHES_DIR, pre_build_config["architecture"]), 'rb') as f: with open(make_toml_path(defaults.BUILD_ARCHES_DIR, pre_build_config["architecture"]), 'rb') as f:
build_arch_config = tomli.load(f) build_arch_config = tomli.load(f)
build_config = merge_dicts(build_arch_config, build_config) build_config = merge_defaults(build_arch_config, defaults=build_config)
## Override with flavor and then CLI arguments ## Override with flavor and then CLI arguments
build_config = merge_dicts(flavor_config, build_config) build_config = merge_defaults(flavor_config, defaults=build_config)
build_config = merge_dicts(args, build_config, skip_none=True) build_config = merge_defaults(args, defaults=build_config, skip_none=True)
## Rename and merge some fields for simplicity ## Rename and merge some fields for simplicity
## E.g. --custom-packages is for the user, but internally ## E.g. --custom-packages is for the user, but internally
@ -333,7 +335,7 @@ if __name__ == "__main__":
if "boot_settings" not in build_config: if "boot_settings" not in build_config:
build_config["boot_settings"] = defaults.boot_settings build_config["boot_settings"] = defaults.boot_settings
else: else:
build_config["boot_settings"] = merge_dicts(defaults.boot_settings, build_config["boot_settings"]) build_config["boot_settings"] = merge_defaults(build_config["boot_settings"], defaults=defaults.boot_settings)
## Convert the image_format field to a single-item list if it's a scalar ## Convert the image_format field to a single-item list if it's a scalar
## (like `image_format = "iso"`) ## (like `image_format = "iso"`)