Administration/pmbootstrap-meow
2
0
Fork 0
forked from Mirror/pmbootstrap
Code Pull requests Activity Actions

treewide: add a Chroot type and adopt pathlib.Path (MR 2252)

Browse source 
Introduce a new module: pmb.core to contain explicitly typed pmbootstrap
API. The first component being Suffix and SuffixType. This explicitly
defines what suffixes are possible, future changes should aim to further
constrain this API (e.g. by validating against available device
codenames or architectures for buildroot suffixes).

Additionally, migrate the entire codebase over to using pathlib.Path.
This is a relatively new part of the Python standard library that uses a
more object oriented model for path handling. It also uses strong type
hinting and has other features that make it much cleaner and easier to
work with than pure f-strings. The Chroot class overloads the "/"
operator the same way the Path object does, allowing one to write paths
relative to a given chroot as:

builddir = chroot / "home/pmos/build"

The Chroot class also has a string representation ("native", or
"rootfs_valve-jupiter"), and a .path property for directly accessing the
absolute path (as a Path object).

The general idea here is to encapsulate common patterns into type hinted
code, and gradually reduce the amount of assumptions made around the
codebase so that future changes are easier to implement.

As the chroot suffixes are now part of the Chroot class, we also
implement validation for them, this encodes the rules on suffix naming
and will cause a runtime exception if a suffix doesn't follow the rules.
This commit is contained in:
Caleb Connolly 2023-06-29 05:25:00 +01:00 • committed by Oliver Smith
parent b31dee9ec3
commit 198f302a36
No known key found for this signature in database
GPG key ID: 5AE7F5513E0885CB
90 changed files with 1600 additions and 1121 deletions
Download patch file Download diff file Expand all files Collapse all files

21
pmb/helpers/run.py
View file

@ -1,11 +1,13 @@
# Copyright 2023 Oliver Smith
# SPDX-License-Identifier: GPL-3.0-or-later
import os
from pathlib import Path
import pmb.helpers.run_core
from argparse import Namespace
from typing import Any, Dict, List, Optional
from typing import Any, Dict, List, Optional, Sequence
from pmb.core.types import PathString, PmbArgs
def user(args: Namespace, cmd: List[str], working_dir: Optional[str]=None, output: str="log", output_return: bool=False,
def user(args: PmbArgs, cmd: Sequence[PathString], working_dir: Path=Path("/"), output: str="log", output_return: bool=False,
check: Optional[bool]=None, env: Dict[Any, Any]={}, sudo: bool=False) -> str:
"""
Run a command on the host system as user.
@ -16,24 +18,25 @@ def user(args: Namespace, cmd: List[str], working_dir: Optional[str]=None, outpu
See pmb.helpers.run_core.core() for a detailed description of all other
arguments and the return value.
"""
cmd_parts = [os.fspath(x) for x in cmd]
# Readable log message (without all the escaping)
msg = "% "
for key, value in env.items():
msg += key + "=" + value + " "
if working_dir:
msg += "cd " + working_dir + "; "
msg += " ".join(cmd)
if working_dir != Path("/"):
msg += f"cd {os.fspath(working_dir)}; "
msg += " ".join(cmd_parts)
# Add environment variables and run
env = env.copy()
pmb.helpers.run_core.add_proxy_env_vars(env)
if env:
cmd = ["sh", "-c", pmb.helpers.run_core.flat_cmd(cmd, env=env)]
return pmb.helpers.run_core.core(args, msg, cmd, working_dir, output,
cmd_parts = ["sh", "-c", pmb.helpers.run_core.flat_cmd(cmd_parts, env=env)]
return pmb.helpers.run_core.core(args, msg, cmd_parts, working_dir, output,
output_return, check, sudo)
def root(args, cmd, working_dir=None, output="log", output_return=False,
def root(args: PmbArgs, cmd: Sequence[PathString], working_dir=None, output="log", output_return=False,
check=None, env={}):
"""Run a command on the host system as root, with sudo or doas.