refactor!: port shell scripts to Python package
Bash scripts were untestable and duplicated device/LUKS/mount logic; the lim/ package centralizes it behind one subprocess wrapper and a YAML image catalog (single point of truth). BREAKING CHANGE: scripts/*.sh removed. Use `lim --type <cmd>`; new types mount/umount/single-boot/raid1-boot/lock/unlock/import/export replace direct script calls. --extra is deprecated and ignored. - distributions.yml + lim/catalog.py hold the image catalog (PyYAML) - pytest suite: 102 tests with mocked subprocess (tests/unit) and a 250-line max file-length guard (tests/lint) - ruff strict (select ALL), GitHub Actions CI, Dependabot; Travis gone - Makefile: install (symlink ~/.local/bin/lim) and test targets - fixes over bash: SUDO_USER-aware chown, mmcblk/nvme partition paths, sha512 checksum support, whole-pipeline failure detection, blkid UUID fallback for pre-mounted images, conditional fstab seeding for PARTUUID/LABEL images, clean errors for missing binaries
This commit is contained in:
Kevin Veen-Birkenbach
118
main.py
118
main.py
@@ -1,118 +1,12 @@
|
||||
#!/usr/bin/env python3
|
||||
import subprocess
|
||||
import os
|
||||
import argparse
|
||||
"""Entry point for the Linux Image Manager (lim)."""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
def run_script(script_path, extra_args):
|
||||
if not os.path.exists(script_path):
|
||||
print(f"[ERROR] Script not found at {script_path}")
|
||||
exit(1)
|
||||
command = ["sudo", "bash", script_path] + extra_args
|
||||
print(f"[INFO] Running command: {' '.join(command)}")
|
||||
# Pass the parent's stdout and stderr so that progress output shows in real time.
|
||||
result = subprocess.run(command, stdout=sys.stdout, stderr=sys.stderr)
|
||||
if result.returncode != 0:
|
||||
print(f"[ERROR] Script exited with code {result.returncode}")
|
||||
exit(result.returncode)
|
||||
print("[SUCCESS] Script executed successfully.")
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parent))
|
||||
|
||||
def main():
|
||||
# Use os.path.realpath to get the actual path of this file regardless of symlinks.
|
||||
repo_root = os.path.dirname(os.path.realpath(__file__))
|
||||
|
||||
# Define available scripts along with their descriptions.
|
||||
setup_scripts = {
|
||||
"image": {
|
||||
"path": os.path.join(repo_root, "scripts", "image", "setup.sh"),
|
||||
"description": (
|
||||
"Linux Image Setup:\n"
|
||||
" - Creates partitions and formats them.\n"
|
||||
" - Transfers the Linux image file to the device.\n"
|
||||
" - Configures boot and root partitions."
|
||||
)
|
||||
},
|
||||
"single": {
|
||||
"path": os.path.join(repo_root, "scripts", "encryption", "storage", "single_drive", "setup.sh"),
|
||||
"description": (
|
||||
"Single Drive Encryption Setup:\n"
|
||||
" - Sets up disk encryption using LUKS on one drive.\n"
|
||||
" - Configures a Btrfs file system for secure storage."
|
||||
)
|
||||
},
|
||||
"raid1": {
|
||||
"path": os.path.join(repo_root, "scripts", "encryption", "storage", "raid1", "setup.sh"),
|
||||
"description": (
|
||||
"RAID1 Encryption Setup:\n"
|
||||
" - Configures a virtual RAID1 with two drives.\n"
|
||||
" - Uses LUKS encryption and a Btrfs RAID1 file system for redundancy."
|
||||
)
|
||||
},
|
||||
"backup": {
|
||||
"path": os.path.join(repo_root, "scripts", "image", "backup.sh"),
|
||||
"description": (
|
||||
"Backup Image Setup:\n"
|
||||
" - Creates an image backup from a memory device to a file.\n"
|
||||
" - Uses dd to transfer the image from the specified device to an image file."
|
||||
)
|
||||
},
|
||||
"chroot": {
|
||||
"path": os.path.join(repo_root, "scripts", "image", "chroot.sh"),
|
||||
"description": (
|
||||
"Chroot Environment Setup:\n"
|
||||
" - Mounts partitions and configures the chroot environment for a Linux image.\n"
|
||||
" - Provides a shell within the Linux image for system maintenance."
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Wrapper for executing various scripts from Linux Image Manager.",
|
||||
epilog=(
|
||||
"Available script types:\n"
|
||||
" image - Linux Image Setup\n"
|
||||
" single - Single Drive Encryption Setup\n"
|
||||
" raid1 - RAID1 Encryption Setup\n"
|
||||
" backup - Backup Image Setup\n"
|
||||
" chroot - Chroot Environment Setup\n\n"
|
||||
"Additional Options:\n"
|
||||
" --extra Pass extra parameters to the selected script.\n"
|
||||
" --auto-confirm Bypass the confirmation prompt before execution.\n"
|
||||
" --help Display this help message and exit."
|
||||
),
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter
|
||||
)
|
||||
parser.add_argument("--type", required=True, choices=list(setup_scripts.keys()),
|
||||
help="Select the script type to execute. Options: " + ", ".join(setup_scripts.keys()))
|
||||
parser.add_argument("--extra", nargs=argparse.REMAINDER, default=[],
|
||||
help="Extra parameters to pass to the selected script.")
|
||||
parser.add_argument("--auto-confirm", action="store_true",
|
||||
help="Automatically confirm execution without prompting the user.")
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
script_info = setup_scripts[args.type]
|
||||
print("[INFO] Selected script type:", args.type)
|
||||
print("[INFO] Description:")
|
||||
print(script_info["description"])
|
||||
print("[INFO] Script path:", script_info["path"])
|
||||
if args.extra:
|
||||
print("[INFO] Extra parameters provided:", " ".join(args.extra))
|
||||
else:
|
||||
print("[INFO] No extra parameters provided.")
|
||||
|
||||
if not args.auto_confirm:
|
||||
try:
|
||||
input("Press Enter to execute the script or Ctrl+C to cancel...")
|
||||
except KeyboardInterrupt:
|
||||
print("\n[ERROR] Execution aborted by user.")
|
||||
exit(1)
|
||||
|
||||
run_script(script_info["path"], args.extra)
|
||||
from lim.cli import main
|
||||
|
||||
if __name__ == "__main__":
|
||||
try:
|
||||
main()
|
||||
except KeyboardInterrupt:
|
||||
print("\n[ERROR] Execution aborted by user.")
|
||||
exit(1)
|
||||
main()
|
||||
|
||||
Reference in New Issue
Block a user