particle-os/debian-forge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

osbuild: describe the result Manifest.build() and Stage.run()

Browse source 
This commit adds mypy annotations and a docstring to make it
easier to trace the result value of an osbuild run.
This commit is contained in:
Michael Vogt 2024-08-05 11:44:12 +02:00 • committed by Achilleas Koutsou
parent 65a7ce2461
commit 2cb57f0ed8
1 changed files with 19 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

28
osbuild/pipeline.py
View file

@ -141,7 +141,7 @@ class Stage:
with open(location, "w", encoding="utf-8") as fp: with open(location, "w", encoding="utf-8") as fp:
json.dump(args, fp) json.dump(args, fp)
def run(self, tree, runner, build_tree, store, monitor, libdir, debug_break="", timeout=None): def run(self, tree, runner, build_tree, store, monitor, libdir, debug_break="", timeout=None) -> BuildResult:
with contextlib.ExitStack() as cm: with contextlib.ExitStack() as cm:
build_root = buildroot.BuildRoot(build_tree, runner.path, libdir, store.tmp) build_root = buildroot.BuildRoot(build_tree, runner.path, libdir, store.tmp)
@ -160,15 +160,15 @@ class Stage:
inputs_tmpdir = os.path.join(tmpdir, "inputs") inputs_tmpdir = os.path.join(tmpdir, "inputs")
os.makedirs(inputs_tmpdir) os.makedirs(inputs_tmpdir)
inputs_mapped = "/run/osbuild/inputs" inputs_mapped = "/run/osbuild/inputs"
inputs = {} inputs: Dict[Any, Any] = {}
devices_mapped = "/dev" devices_mapped = "/dev"
devices = {} devices: Dict[Any, Any] = {}
mounts_tmpdir = os.path.join(tmpdir, "mounts") mounts_tmpdir = os.path.join(tmpdir, "mounts")
os.makedirs(mounts_tmpdir) os.makedirs(mounts_tmpdir)
mounts_mapped = "/run/osbuild/mounts" mounts_mapped = "/run/osbuild/mounts"
mounts = {} mounts: Dict[Any, Any] = {}
os.makedirs(os.path.join(tmpdir, "api")) os.makedirs(os.path.join(tmpdir, "api"))
args_path = os.path.join(tmpdir, "api", "arguments") args_path = os.path.join(tmpdir, "api", "arguments")
@ -209,8 +209,8 @@ class Stage:
ipmgr = InputManager(mgr, storeapi, inputs_tmpdir) ipmgr = InputManager(mgr, storeapi, inputs_tmpdir)
for key, ip in self.inputs.items(): for key, ip in self.inputs.items():
data = ipmgr.map(ip) data_inp = ipmgr.map(ip)
inputs[key] = data inputs[key] = data_inp
devmgr = DeviceManager(mgr, build_root.dev, tree) devmgr = DeviceManager(mgr, build_root.dev, tree)
for name, dev in self.devices.items(): for name, dev in self.devices.items():
@ -218,8 +218,8 @@ class Stage:
mntmgr = MountManager(devmgr, mounts_tmpdir) mntmgr = MountManager(devmgr, mounts_tmpdir)
for key, mount in self.mounts.items(): for key, mount in self.mounts.items():
data = mntmgr.mount(mount) data_mnt = mntmgr.mount(mount)
mounts[key] = data mounts[key] = data_mnt
self.prepare_arguments(args, args_path) self.prepare_arguments(args, args_path)
@ -473,10 +473,20 @@ class Manifest:
return list(map(lambda x: x.name, reversed(build.values()))) return list(map(lambda x: x.name, reversed(build.values())))
def build(self, store, pipelines, monitor, libdir, debug_break="", stage_timeout=None): def build(self, store, pipelines, monitor, libdir, debug_break="", stage_timeout=None) -> Dict[str, Any]:
"""Build the manifest
Returns a dict of string keys that contains the overall
"success" and the `BuildResult` of each individual pipeline.
The overall success "success" is stored as the string "success"
with the bool result and the build pipelines BuildStatus is
stored under the pipelines ID string.
"""
results = {"success": True} results = {"success": True}
for pl in map(self.get, pipelines): for pl in map(self.get, pipelines):
assert pl is not None
res = pl.run(store, monitor, libdir, debug_break, stage_timeout) res = pl.run(store, monitor, libdir, debug_break, stage_timeout)
results[pl.id] = res results[pl.id] = res
if not res["success"]: if not res["success"]: