forked from Mirror/pmbootstrap
7d2f055bcb
This allows us to get rid of some of the validation in sanity_checks() as mypy handles this validation at "build time", and any typos in the enum instantiation would be a runtime error rather than a silent failure. Additionally, it allows us to encode some of the behaviour of the different output types into the type definition itself by using methods. Part-of: https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/-/merge_requests/2642
129 lines
3.5 KiB
Python
129 lines
3.5 KiB
Python
# Copyright 2023 Oliver Smith
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
import os
|
|
from pathlib import Path
|
|
import subprocess
|
|
import pmb.helpers.run_core
|
|
from collections.abc import Sequence
|
|
from typing import overload, Literal
|
|
from pmb.types import (
|
|
Env,
|
|
PathString,
|
|
RunOutputType,
|
|
RunOutputTypeDefault,
|
|
RunOutputTypePopen,
|
|
RunReturnType,
|
|
)
|
|
|
|
|
|
def user(
|
|
cmd: Sequence[PathString],
|
|
working_dir: Path | None = None,
|
|
output: RunOutputType = RunOutputTypeDefault.LOG,
|
|
output_return: bool = False,
|
|
check: bool | None = None,
|
|
env: Env = {},
|
|
sudo: bool = False,
|
|
) -> RunReturnType:
|
|
"""
|
|
Run a command on the host system as user.
|
|
|
|
:param env: dict of environment variables to be passed to the command, e.g.
|
|
{"JOBS": "5"}
|
|
|
|
See pmb.helpers.run_core.core() for a detailed description of all other
|
|
arguments and the return value.
|
|
"""
|
|
cmd_parts = [os.fspath(c) for c in cmd]
|
|
|
|
# Readable log message (without all the escaping)
|
|
msg = "% "
|
|
for key, value in env.items():
|
|
msg += f"{key}={value} "
|
|
if working_dir is not None:
|
|
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_parts = ["sh", "-c", pmb.helpers.run_core.flat_cmd([cmd_parts], env=env)]
|
|
return pmb.helpers.run_core.core(
|
|
msg, cmd_parts, working_dir, output, output_return, check, sudo
|
|
)
|
|
|
|
|
|
# FIXME: should probably use some kind of wrapper class / builder pattern for all these parameters...
|
|
def user_output(
|
|
cmd: Sequence[PathString],
|
|
working_dir: Path | None = None,
|
|
output: RunOutputType = RunOutputTypeDefault.LOG,
|
|
check: bool | None = None,
|
|
env: Env = {},
|
|
sudo: bool = False,
|
|
) -> str:
|
|
ret = user(cmd, working_dir, output, output_return=True, check=check, env=env, sudo=sudo)
|
|
if not isinstance(ret, str):
|
|
raise TypeError("Expected str output, got " + str(ret))
|
|
|
|
return ret
|
|
|
|
|
|
@overload
|
|
def root(
|
|
cmd: Sequence[PathString],
|
|
working_dir: Path | None = ...,
|
|
output: RunOutputTypePopen = ...,
|
|
output_return: Literal[False] = ...,
|
|
check: bool | None = ...,
|
|
env: Env = ...,
|
|
) -> subprocess.Popen: ...
|
|
|
|
|
|
@overload
|
|
def root(
|
|
cmd: Sequence[PathString],
|
|
working_dir: Path | None = ...,
|
|
output: RunOutputTypeDefault = ...,
|
|
output_return: Literal[False] = ...,
|
|
check: bool | None = ...,
|
|
env: Env = ...,
|
|
) -> int: ...
|
|
|
|
|
|
@overload
|
|
def root(
|
|
cmd: Sequence[PathString],
|
|
working_dir: Path | None = ...,
|
|
output: RunOutputType = ...,
|
|
output_return: Literal[True] = ...,
|
|
check: bool | None = ...,
|
|
env: Env = ...,
|
|
) -> str: ...
|
|
|
|
|
|
def root(
|
|
cmd: Sequence[PathString],
|
|
working_dir: Path | None = None,
|
|
output: RunOutputType = RunOutputTypeDefault.LOG,
|
|
output_return: bool = False,
|
|
check: bool | None = None,
|
|
env: Env = {},
|
|
) -> RunReturnType:
|
|
"""Run a command on the host system as root, with sudo or doas.
|
|
|
|
:param env: dict of environment variables to be passed to the command, e.g.
|
|
{"JOBS": "5"}
|
|
|
|
See pmb.helpers.run_core.core() for a detailed description of all other
|
|
arguments and the return value.
|
|
"""
|
|
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)]
|
|
cmd = pmb.config.sudo(cmd)
|
|
|
|
return user(cmd, working_dir, output, output_return, check, env, True)
|