mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-08 11:46:35 +00:00
kevinveenbirkenbach
505af3e2ad
- Change --log flag to require explicit log directory (--log <LOG_DIR>) - Automatically create log directory with parents=True - Harden permissions best-effort (0700) - Update CLI help text accordingly - Adjust Makefile test targets to pass explicit log directory - Ignore logs/ via .gitignore and .dockerignore - Refactor flag parsing to correctly detect deploy with --log - Add dedicated logging unit tests - Update existing tests for new log semantics - Remove deprecated -i alias for --id in deploy command https://chatgpt.com/share/6969680a-dbf8-800f-aafb-3d32d6212ba0
100 lines
2.8 KiB
Python
100 lines
2.8 KiB
Python
from __future__ import annotations
|
|
|
|
import os
|
|
import pty
|
|
import subprocess
|
|
from dataclasses import dataclass
|
|
from datetime import datetime
|
|
from pathlib import Path
|
|
from typing import List, TextIO
|
|
|
|
from cli.core.colors import Fore, color_text
|
|
from cli.core.sounds import failure_with_warning_loop
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class RunConfig:
|
|
no_signal: bool
|
|
sound_enabled: bool
|
|
alarm_timeout: int
|
|
log_enabled: bool
|
|
|
|
|
|
def open_log_file(log_dir: Path) -> tuple[TextIO, Path]:
|
|
"""
|
|
Create/open a timestamped log file inside log_dir.
|
|
|
|
- log_dir is mandatory (provided via --log <LOG_DIR>)
|
|
- log_dir is created with parents=True if missing
|
|
"""
|
|
log_dir = log_dir.expanduser()
|
|
log_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Best-effort permission hardening (ignore failures on non-POSIX / special FS)
|
|
try:
|
|
os.chmod(log_dir, 0o700)
|
|
except Exception:
|
|
pass
|
|
|
|
timestamp = datetime.now().strftime("%Y%m%dT%H%M%S")
|
|
log_file_path = log_dir / f"{timestamp}.log"
|
|
fd = os.open(str(log_file_path), os.O_WRONLY | os.O_CREAT | os.O_APPEND, 0o600)
|
|
return os.fdopen(fd, "a", encoding="utf-8"), log_file_path
|
|
|
|
|
|
def run_command_once(
|
|
full_cmd: List[str], cfg: RunConfig, log_file: TextIO | None
|
|
) -> bool:
|
|
try:
|
|
if cfg.log_enabled and log_file is not None:
|
|
master_fd, slave_fd = pty.openpty()
|
|
proc = subprocess.Popen(
|
|
full_cmd,
|
|
stdin=slave_fd,
|
|
stdout=slave_fd,
|
|
stderr=slave_fd,
|
|
text=True,
|
|
)
|
|
os.close(slave_fd)
|
|
|
|
import errno
|
|
|
|
with os.fdopen(master_fd) as master:
|
|
try:
|
|
for line in master:
|
|
ts = datetime.now().strftime("%Y-%m-%dT%H:%M:%S")
|
|
log_file.write(f"{ts} {line}")
|
|
log_file.flush()
|
|
print(line, end="")
|
|
except OSError as e:
|
|
if e.errno != errno.EIO:
|
|
raise
|
|
|
|
proc.wait()
|
|
rc = proc.returncode
|
|
else:
|
|
proc = subprocess.Popen(full_cmd)
|
|
proc.wait()
|
|
rc = proc.returncode
|
|
|
|
if rc != 0:
|
|
failure_with_warning_loop(
|
|
cfg.no_signal, cfg.sound_enabled, cfg.alarm_timeout
|
|
)
|
|
raise SystemExit(rc)
|
|
|
|
# Success signal (in main process, as before)
|
|
if not cfg.no_signal:
|
|
from module_utils.sounds import Sound
|
|
|
|
Sound.play_finished_successfully_sound()
|
|
|
|
return True
|
|
|
|
except SystemExit:
|
|
raise
|
|
except Exception as e:
|
|
print(color_text(f"Exception running command: {e}", Fore.RED))
|
|
failure_with_warning_loop(cfg.no_signal, cfg.sound_enabled, cfg.alarm_timeout)
|
|
raise SystemExit(1)
|