fix(config): write config.json through one durable atomic writer (#611)

save_config() opened config.json with 'w' and streamed json.dump into it,
so a power cut or an unencodable value left the file truncated.
save_config_atomic() renamed a temp file into place but never fsynced it,
rewrote the unchanged secrets file on every save, and re-parsed every
backup to rotate them. save_raw_file_content() had its own third copy.

All of them, plus rollback and config creation from the template, now go
through atomic_write_text(): temp file in the same directory, fsync,
final mode set before the rename, rename (retried on Windows while a
reader holds the file), directory fsync. A root save copies the previous
owner onto the new file so a rename by the display service no longer
hands config.json to root; the shared-group fix-up is unchanged. The
mode is chosen from the file name, so a "secrets" directory in the
install path no longer makes config.json 0640.

The secrets file is rewritten only when its content changes, and backup
rotation works from filenames alone. Backups keep their names
(config/backups/config.json.backup.<version>, paired secrets backup) and
the five newest are kept, as before.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Chuck
2026-09-23 12:52:50 -04:00
committed by GitHub
co-authored by Claude Opus 5.5
parent 604f58ff07
commit 269385c97c
4 changed files with 619 additions and 293 deletions
+16
View File
@@ -44,6 +44,22 @@ core, the monorepo or the registry's third-party plugins calls them:
`unregister_plugin_fonts`. `unregister_plugin_fonts`.
- `PluginManager.get_enabled_plugins`. - `PluginManager.get_enabled_plugins`.
### Config writes
- A power cut or crash mid-save can no longer leave `config/config.json`
truncated. `ConfigManager.save_config()` wrote the file in place; it,
`save_config_atomic()`, `save_raw_file_content()` and backup rollback now
share one writer (`atomic_write_text` in `src/config_manager_atomic.py`)
that fsyncs a temp file, renames it into place and fsyncs the directory.
- `save_config_atomic()` no longer rewrites `config_secrets.json` on every
save, only when its content changes, and rotating backups no longer re-reads
every backup. The backups themselves are unchanged:
`config/backups/config.json.backup.<version>` plus its paired secrets
backup, five newest kept.
- A save by the root-run display service keeps the file's previous owner
instead of handing `config.json` to root, and an install path with
"secrets" in a directory name no longer makes `config.json` mode 0640.
## 3.5.0 ## 3.5.0
New modules a plugin may import via `src.*` (floor on 3.5.0): New modules a plugin may import via `src.*` (floor on 3.5.0):
+14 -64
View File
@@ -7,9 +7,11 @@ files:
* ``config/config.json`` — main user-editable configuration. * ``config/config.json`` — main user-editable configuration.
* ``config/config_secrets.json`` — sensitive values (API keys, tokens). * ``config/config_secrets.json`` — sensitive values (API keys, tokens).
All writes go through :class:`~src.config_manager_atomic.AtomicConfigManager` Every write of either file goes through
which performs a backup before overwriting, validates the result, and rolls :func:`~src.config_manager_atomic.atomic_write_text`: temp file, fsync,
back on error. This makes config corruption essentially impossible. rename, directory fsync. A crash or power cut mid-save leaves the old file or
the new one, never a truncated one. :meth:`ConfigManager.save_config_atomic`
additionally keeps rotating backups in ``config/backups/``.
Plugin configuration Plugin configuration
-------------------- --------------------
@@ -34,13 +36,11 @@ from src.exceptions import ConfigError
from src.logging_config import get_logger from src.logging_config import get_logger
from src.config_manager_atomic import ( from src.config_manager_atomic import (
AtomicConfigManager, SaveResult, SaveResultStatus, AtomicConfigManager, SaveResult, SaveResultStatus,
BackupInfo, ValidationResult BackupInfo, ValidationResult, atomic_write_json
) )
from src.common.permission_utils import ( from src.common.permission_utils import (
ensure_directory_permissions, ensure_directory_permissions,
ensure_file_permissions,
ensure_shared_group_ownership, ensure_shared_group_ownership,
get_config_file_mode,
get_config_dir_mode get_config_dir_mode
) )
@@ -114,11 +114,12 @@ class ConfigManager:
# Strip secrets from main config before saving # Strip secrets from main config before saving
config_to_write = self._strip_secrets_recursive(new_config_data, secrets_content) config_to_write = self._strip_secrets_recursive(new_config_data, secrets_content)
# Use atomic manager to save # The secrets file is only read here, never changed, so it is not
# handed over for rewriting.
atomic_mgr = self._get_atomic_manager() atomic_mgr = self._get_atomic_manager()
result = atomic_mgr.save_config_atomic( result = atomic_mgr.save_config_atomic(
new_config=config_to_write, new_config=config_to_write,
new_secrets=secrets_content if secrets_content else None, new_secrets=None,
create_backup=create_backup, create_backup=create_backup,
validate_after_write=validate_after_write validate_after_write=validate_after_write
) )
@@ -354,8 +355,7 @@ class ConfigManager:
config_to_write = self._strip_secrets_recursive(new_config_data, secrets_content) config_to_write = self._strip_secrets_recursive(new_config_data, secrets_content)
try: try:
with open(self.config_path, 'w') as f: atomic_write_json(self.config_path, config_to_write)
json.dump(config_to_write, f, indent=4)
# Update the in-memory config to the new state (which includes secrets for runtime) # Update the in-memory config to the new state (which includes secrets for runtime)
self.config = new_config_data self.config = new_config_data
@@ -438,13 +438,7 @@ class ConfigManager:
with open(self.template_path, 'r') as template_file: with open(self.template_path, 'r') as template_file:
template_data = json.load(template_file) template_data = json.load(template_file)
with open(self.config_path, 'w') as config_file: atomic_write_json(self.config_path, template_data)
json.dump(template_data, config_file, indent=4)
# Set proper file permissions after creation
config_path_obj = Path(self.config_path)
ensure_file_permissions(config_path_obj, get_config_file_mode(config_path_obj))
ensure_shared_group_ownership(config_path_obj)
self.logger.info(f"Created config.json from template at {os.path.abspath(self.config_path)}") self.logger.info(f"Created config.json from template at {os.path.abspath(self.config_path)}")
@@ -600,53 +594,9 @@ class ConfigManager:
path_obj = Path(path_to_save) path_obj = Path(path_to_save)
ensure_directory_permissions(path_obj.parent, get_config_dir_mode()) ensure_directory_permissions(path_obj.parent, get_config_dir_mode())
# Use atomic write: write to temp file first, then move atomically # A rename, not an in-place write, so this works even when the
# This works even if the existing file isn't writable (as long as directory is writable) # existing file isn't writable (as long as the directory is).
import tempfile atomic_write_json(path_obj, data)
file_mode = get_config_file_mode(path_obj)
# Create temp file in same directory to ensure atomic move works
temp_fd, temp_path = tempfile.mkstemp(
suffix='.json',
dir=str(path_obj.parent),
text=True
)
try:
# Write to temp file
with os.fdopen(temp_fd, 'w', encoding='utf-8') as f:
json.dump(data, f, indent=4)
f.flush()
os.fsync(f.fileno())
# Set permissions on temp file before moving
try:
os.chmod(temp_path, file_mode)
except OSError:
pass # Non-critical if chmod fails
# Atomically move temp file to final location
# This works even if target file exists and isn't writable
os.replace(temp_path, str(path_obj))
temp_path = None # Mark as moved so we don't try to clean it up
# Ensure final file has correct permissions
try:
ensure_file_permissions(path_obj, file_mode)
ensure_shared_group_ownership(path_obj)
except OSError as perm_error:
# If we can't set permissions but file was written, log warning but don't fail
self.logger.warning(
f"File {path_to_save} was written successfully but could not set permissions: {perm_error}. "
f"This may cause issues if the file needs to be accessible by other users."
)
finally:
# Clean up temp file if it still exists (move failed)
if temp_path and os.path.exists(temp_path):
try:
os.remove(temp_path)
except OSError:
pass
self.logger.info(f"{file_type.capitalize()} configuration successfully saved to {os.path.abspath(path_to_save)}") self.logger.info(f"{file_type.capitalize()} configuration successfully saved to {os.path.abspath(path_to_save)}")
+211 -198
View File
@@ -10,15 +10,16 @@ import os
import re import re
import shutil import shutil
import tempfile import tempfile
import time
from datetime import datetime, timedelta from datetime import datetime, timedelta
from pathlib import Path from pathlib import Path
from typing import Dict, Any, Optional, List, Tuple from typing import Dict, Any, Optional, List, Tuple, Union
from dataclasses import dataclass from dataclasses import dataclass
from enum import Enum from enum import Enum
from src.exceptions import ConfigError from src.exceptions import ConfigError
from src.logging_config import get_logger from src.logging_config import get_logger
from src.common.permission_utils import ensure_shared_group_ownership from src.common.permission_utils import ensure_shared_group_ownership, get_config_file_mode
# Version stamp in a backup's filename: config.json.backup.<version>. # Version stamp in a backup's filename: config.json.backup.<version>.
BACKUP_VERSION_FORMAT = "%Y%m%d_%H%M%S_%f" BACKUP_VERSION_FORMAT = "%Y%m%d_%H%M%S_%f"
@@ -33,6 +34,98 @@ LEGACY_BACKUP_VERSION_FORMAT = "%Y%m%d_%H%M%S"
# mistaken for one and silently mis-parsed. # mistaken for one and silently mis-parsed.
_BACKUP_COLLISION_SUFFIX_RE = re.compile(r"^(?P<base>.+)-(?P<collision>\d+)$") _BACKUP_COLLISION_SUFFIX_RE = re.compile(r"^(?P<base>.+)-(?P<collision>\d+)$")
# Windows refuses to rename over a file another process has open (a reader
# mid-load). Linux never does, so this only ever retries on a dev machine.
_WINDOWS_REPLACE_ATTEMPTS = 10
_WINDOWS_REPLACE_DELAY = 0.05
def _replace(source: Path, destination: Path) -> None:
for attempt in range(_WINDOWS_REPLACE_ATTEMPTS):
try:
os.replace(source, destination)
return
except PermissionError:
if os.name != 'nt' or attempt == _WINDOWS_REPLACE_ATTEMPTS - 1:
raise
time.sleep(_WINDOWS_REPLACE_DELAY)
def _fsync_directory(directory: Path) -> None:
"""Persist a rename: until the directory entry itself is on disk, a power
cut can bring back the old file, or on some filesystems neither. Windows
can't open a directory for fsync, and NTFS journals renames anyway."""
if os.name == 'nt':
return
try:
fd = os.open(directory, os.O_RDONLY)
except OSError:
return
try:
os.fsync(fd)
except OSError:
pass
finally:
os.close(fd)
def atomic_write_text(path: Union[str, Path], text: str, mode: Optional[int] = None) -> None:
"""
Replace ``path`` with ``text`` so that a crash or power cut at any point
leaves either the old file or the new one, never a truncated mix.
The data goes to a temp file in the same directory, is fsynced, and is
renamed over the target; the directory is then fsynced so the rename
itself survives. The temp file gets its final mode (0o644, or 0o640 when
the file name contains "secrets"; a directory name doesn't count) before
the rename, so no reader ever sees mkstemp's 0o600.
A rename hands the file to whoever wrote it. When running as root (the
display service) the previous owner is copied onto the temp file first,
so a root save doesn't leave the web user's config.json owned by root;
the group is then moved to the shared one (ensure_shared_group_ownership)
as before. On failure the temp file is removed, the target is untouched,
and the error propagates.
"""
path = Path(path)
if mode is None:
mode = get_config_file_mode(Path(path.name))
try:
previous = path.stat()
except OSError:
previous = None
fd, temp_name = tempfile.mkstemp(dir=str(path.parent), prefix=f".{path.name}.tmp.")
temp_path = Path(temp_name)
try:
with os.fdopen(fd, 'wb') as f:
f.write(text.encode('utf-8'))
f.flush()
os.fsync(f.fileno())
if previous is not None and hasattr(os, 'geteuid') and os.geteuid() == 0:
try:
os.chown(temp_path, previous.st_uid, previous.st_gid)
except OSError:
pass
os.chmod(temp_path, mode)
_replace(temp_path, path)
except BaseException:
try:
temp_path.unlink()
except OSError:
pass
raise
ensure_shared_group_ownership(path)
_fsync_directory(path.parent)
def atomic_write_json(path: Union[str, Path], data: Any, mode: Optional[int] = None) -> None:
"""Serialize ``data`` the way every config file is written (indent=4) and
write it with :func:`atomic_write_text`. Serialization happens first, so
a value json can't encode fails before anything on disk changes."""
atomic_write_text(path, json.dumps(data, indent=4), mode)
class SaveResultStatus(Enum): class SaveResultStatus(Enum):
"""Status of a save operation.""" """Status of a save operation."""
@@ -75,11 +168,11 @@ class AtomicConfigManager:
Manages atomic configuration saves with backup and rollback support. Manages atomic configuration saves with backup and rollback support.
Provides: Provides:
- Atomic file writes (write to temp, validate, atomic move) - Durable atomic file writes (see atomic_write_text)
- Automatic backups before saves - Automatic backups before saves
- Backup rotation (keep last N backups) - Backup rotation (keep last N backups)
- Rollback functionality - Rollback functionality
- Post-write validation - Validation before the write
""" """
def __init__( def __init__(
@@ -94,7 +187,8 @@ class AtomicConfigManager:
Args: Args:
config_path: Path to main configuration file config_path: Path to main configuration file
secrets_path: Optional path to secrets file (saved atomically with main config) secrets_path: Optional path to secrets file (backed up with the main
config, and rewritten by a save only when its content changes)
backup_dir: Directory to store backups (default: config/backups/) backup_dir: Directory to store backups (default: config/backups/)
max_backups: Maximum number of backups to keep max_backups: Maximum number of backups to keep
""" """
@@ -126,16 +220,18 @@ class AtomicConfigManager:
Process: Process:
1. Create backup if requested 1. Create backup if requested
2. Write to temporary files 2. Serialize and validate the new content in memory
3. Validate written files 3. Write each file with atomic_write_text (temp file, fsync, rename)
4. Atomically move temp files to final locations
5. If validation fails, rollback The secrets file is only rewritten when ``new_secrets`` differs from
what is already on disk.
Args: Args:
new_config: New configuration data for main config file new_config: New configuration data for main config file
new_secrets: Optional new secrets data new_secrets: Optional new secrets data
create_backup: Whether to create backup before saving create_backup: Whether to create backup before saving
validate_after_write: Whether to validate after writing validate_after_write: Whether to validate the content before it
replaces the config file
Returns: Returns:
SaveResult with status and details SaveResult with status and details
@@ -143,7 +239,6 @@ class AtomicConfigManager:
backup_path = None backup_path = None
try: try:
# Step 1: Create backup if requested
if create_backup: if create_backup:
backup_result = self._create_backup() backup_result = self._create_backup()
if backup_result: if backup_result:
@@ -152,22 +247,11 @@ class AtomicConfigManager:
else: else:
self.logger.warning("Failed to create backup, continuing with save") self.logger.warning("Failed to create backup, continuing with save")
# Step 2: Write to temporary files config_text, secrets_text = self._serialize(new_config, new_secrets)
temp_config_path, temp_secrets_path = self._write_to_temp_files(
new_config, new_secrets
)
# Step 3: Validate written files
if validate_after_write: if validate_after_write:
validation_result = self._validate_config_file(temp_config_path) validation_result = self._validate_config_text(config_text)
if not validation_result.is_valid: if not validation_result.is_valid:
# Clean up temp files
self._cleanup_temp_files(temp_config_path, temp_secrets_path)
# Rollback if backup was created
if backup_path:
self._rollback_from_backup(backup_path)
return SaveResult( return SaveResult(
status=SaveResultStatus.VALIDATION_FAILED, status=SaveResultStatus.VALIDATION_FAILED,
message="Configuration validation failed after write", message="Configuration validation failed after write",
@@ -175,10 +259,9 @@ class AtomicConfigManager:
validation_errors=validation_result.errors validation_errors=validation_result.errors
) )
# Step 4: Atomically move temp files to final locations atomic_write_text(self.config_path, config_text)
self._atomic_move(temp_config_path, self.config_path) if secrets_text is not None:
if temp_secrets_path and self.secrets_path: atomic_write_text(self.secrets_path, secrets_text)
self._atomic_move(temp_secrets_path, self.secrets_path)
self.logger.info(f"Configuration saved atomically to {self.config_path}") self.logger.info(f"Configuration saved atomically to {self.config_path}")
@@ -256,16 +339,31 @@ class AtomicConfigManager:
List of BackupInfo objects, sorted by timestamp (newest first) List of BackupInfo objects, sorted by timestamp (newest first)
""" """
backups = [] backups = []
for version, backup_file, timestamp in self._backup_entries():
if not self.backup_dir.exists(): try:
backups.append(BackupInfo(
version=version,
path=str(backup_file),
timestamp=timestamp,
size=backup_file.stat().st_size,
is_valid=self._validate_backup_file(backup_file)
))
except Exception as e:
self.logger.warning(f"Error reading backup {backup_file}: {e}")
return backups return backups
# Look for backup files (format: config.json.backup.<version>) def _backup_entries(self) -> List[Tuple[str, Path, datetime]]:
config_name = self.config_path.name """
backup_pattern = f"{config_name}.backup.*" ``(version, path, timestamp)`` for every ``config.json.backup.<version>``
in the backup directory, newest first. Names only -- no file is opened,
so rotation can call this on every save without re-parsing each backup.
"""
entries = []
if not self.backup_dir.exists():
return entries
for backup_file in self.backup_dir.glob(backup_pattern): prefix = f"{self.config_path.name}.backup."
try: for backup_file in self.backup_dir.glob(f"{prefix}*"):
# The version reported here is what rollback_config() matches # The version reported here is what rollback_config() matches
# against, so it has to be the exact string in the filename. # against, so it has to be the exact string in the filename.
# #
@@ -280,33 +378,21 @@ class AtomicConfigManager:
# whichever the glob happened to yield first. # whichever the glob happened to yield first.
# Strip the exact prefix the glob just matched, so a config # Strip the exact prefix the glob just matched, so a config
# whose own name contains '.backup.' can't shift the split. # whose own name contains '.backup.' can't shift the split.
timestamp_str = backup_file.name[len(f"{config_name}.backup."):] version = backup_file.name[len(prefix):]
timestamp = self._parse_backup_version(timestamp_str) timestamp = self._parse_backup_version(version)
if timestamp is None: if timestamp is None:
# Not a version this code wrote (hand-copied, renamed). # Not a version this code wrote (hand-copied, renamed).
# Order it by mtime, but keep the on-disk version string so # Order it by mtime, but keep the on-disk version string so
# it can still be named in a rollback. # it can still be named in a rollback.
try:
timestamp = datetime.fromtimestamp(backup_file.stat().st_mtime) timestamp = datetime.fromtimestamp(backup_file.stat().st_mtime)
except OSError as e:
# Validate backup file
is_valid = self._validate_backup_file(backup_file)
backup_info = BackupInfo(
version=timestamp_str,
path=str(backup_file),
timestamp=timestamp,
size=backup_file.stat().st_size,
is_valid=is_valid
)
backups.append(backup_info)
except Exception as e:
self.logger.warning(f"Error reading backup {backup_file}: {e}") self.logger.warning(f"Error reading backup {backup_file}: {e}")
continue
entries.append((version, backup_file, timestamp))
# Sort by timestamp (newest first) entries.sort(key=lambda entry: entry[2], reverse=True)
backups.sort(key=lambda b: b.timestamp, reverse=True) return entries
return backups
@staticmethod @staticmethod
def _parse_backup_version(version: str) -> Optional[datetime]: def _parse_backup_version(version: str) -> Optional[datetime]:
@@ -417,100 +503,37 @@ class AtomicConfigManager:
self.logger.error(f"Error creating backup: {e}", exc_info=True) self.logger.error(f"Error creating backup: {e}", exc_info=True)
return None return None
def _write_to_temp_files( def _serialize(
self, self,
config_data: Dict[str, Any], config_data: Dict[str, Any],
secrets_data: Optional[Dict[str, Any]] = None secrets_data: Optional[Dict[str, Any]] = None
) -> Tuple[Path, Optional[Path]]: ) -> Tuple[str, Optional[str]]:
""" """
Write configuration data to temporary files. Serialize both files before either is written, so a value json can't
encode fails the save before anything on disk changes.
Returns: Returns:
Tuple of (temp_config_path, temp_secrets_path) Tuple of (config_text, secrets_text); secrets_text is None when
""" there is no secrets file to write or its content is unchanged.
# Create temp file in same directory as config (for atomic move)
temp_config = tempfile.NamedTemporaryFile(
mode='w',
dir=self.config_path.parent,
prefix=f".{self.config_path.name}.tmp.",
delete=False,
suffix='.json'
)
temp_config_path = Path(temp_config.name)
try:
json.dump(config_data, temp_config, indent=4)
temp_config.close()
except Exception as e:
temp_config.close()
if temp_config_path.exists():
temp_config_path.unlink()
raise ConfigError(f"Error writing temp config file: {e}") from e
# Write secrets to temp file if provided
temp_secrets_path = None
if secrets_data is not None and self.secrets_path:
temp_secrets = tempfile.NamedTemporaryFile(
mode='w',
dir=self.secrets_path.parent,
prefix=f".{self.secrets_path.name}.tmp.",
delete=False,
suffix='.json'
)
temp_secrets_path = Path(temp_secrets.name)
try:
json.dump(secrets_data, temp_secrets, indent=4)
temp_secrets.close()
except Exception as e:
temp_secrets.close()
if temp_secrets_path.exists():
temp_secrets_path.unlink()
# Clean up config temp file too
if temp_config_path.exists():
temp_config_path.unlink()
raise ConfigError(f"Error writing temp secrets file: {e}") from e
return temp_config_path, temp_secrets_path
def _atomic_move(self, source: Path, destination: Path) -> None:
"""
Atomically move a file (rename operation).
On most filesystems, rename is atomic, which prevents corruption
if the process is interrupted.
Sets appropriate file permissions after move to ensure service can read config.
""" """
try: try:
# Ensure destination directory exists config_text = json.dumps(config_data, indent=4)
destination.parent.mkdir(parents=True, exist_ok=True) except (TypeError, ValueError) as e:
raise ConfigError(f"Error serializing config: {e}") from e
# Determine target permissions based on file type if secrets_data is None or not self.secrets_path or self._secrets_unchanged(secrets_data):
# config.json should be 644 (readable by all, including root service) return config_text, None
# config_secrets.json should be 640 (readable by owner and group) try:
if 'secrets' in str(destination): return config_text, json.dumps(secrets_data, indent=4)
target_mode = 0o640 # rw-r----- except (TypeError, ValueError) as e:
else: raise ConfigError(f"Error serializing secrets: {e}") from e
target_mode = 0o644 # rw-r--r--
# Atomic move (rename) def _secrets_unchanged(self, secrets_data: Dict[str, Any]) -> bool:
source.replace(destination) try:
with open(self.secrets_path, 'r') as f:
# Set permissions after move to ensure they're correct return json.load(f) == secrets_data
# This is important because temp files may have different permissions except (OSError, ValueError):
# and we need root service to be able to read config.json return False
os.chmod(destination, target_mode)
# Also fix group ownership when this save is running as root
# (the display service): 0o640 alone only helps the non-root web
# user read a root-written secrets file if its group already
# matches the web user's group, which isn't guaranteed. See
# permission_utils.ensure_shared_group_ownership for why.
ensure_shared_group_ownership(destination)
except Exception as e:
raise ConfigError(f"Error during atomic move: {e}") from e
def _validate_config_file(self, config_path: Path) -> ValidationResult: def _validate_config_file(self, config_path: Path) -> ValidationResult:
""" """
@@ -521,30 +544,38 @@ class AtomicConfigManager:
- Valid JSON format - Valid JSON format
- Can be parsed successfully - Can be parsed successfully
""" """
errors = []
warnings = []
if not config_path.exists(): if not config_path.exists():
errors.append(f"Config file does not exist: {config_path}") return ValidationResult(
return ValidationResult(is_valid=False, errors=errors, warnings=warnings) is_valid=False,
errors=[f"Config file does not exist: {config_path}"],
warnings=[]
)
try: try:
with open(config_path, 'r') as f: with open(config_path, 'r') as f:
data = json.load(f) text = f.read()
except Exception as e:
return ValidationResult(
is_valid=False,
errors=[f"Error reading config file: {str(e)}"],
warnings=[]
)
return self._validate_config_text(text)
# Basic validation: should be a dict @staticmethod
def _validate_config_text(text: str) -> ValidationResult:
"""Validate serialized configuration: parseable JSON holding an object."""
errors = []
warnings = []
try:
data = json.loads(text)
if not isinstance(data, dict): if not isinstance(data, dict):
errors.append("Configuration must be a JSON object") errors.append("Configuration must be a JSON object")
# Check file is not empty
if not data: if not data:
warnings.append("Configuration file is empty") warnings.append("Configuration file is empty")
except json.JSONDecodeError as e: except json.JSONDecodeError as e:
errors.append(f"Invalid JSON: {str(e)}") errors.append(f"Invalid JSON: {str(e)}")
except Exception as e: except Exception as e:
errors.append(f"Error reading config file: {str(e)}") errors.append(f"Error reading config file: {str(e)}")
return ValidationResult( return ValidationResult(
is_valid=len(errors) == 0, is_valid=len(errors) == 0,
errors=errors, errors=errors,
@@ -563,6 +594,9 @@ class AtomicConfigManager:
""" """
Rollback configuration from a backup file. Rollback configuration from a backup file.
The backup is written back with atomic_write_text, so a failure
partway through a restore can't truncate the live config either.
Args: Args:
backup_path: Path to backup file to restore backup_path: Path to backup file to restore
@@ -575,28 +609,25 @@ class AtomicConfigManager:
self.logger.error(f"Backup file not found: {backup_path}") self.logger.error(f"Backup file not found: {backup_path}")
return False return False
# Validate backup before restoring try:
if not self._validate_backup_file(backup_file): with open(backup_file, 'r') as f:
config_text = f.read()
except Exception as e:
self.logger.error(f"Error reading backup {backup_path}: {e}", exc_info=True)
return False
if not self._validate_config_text(config_text).is_valid:
self.logger.error(f"Backup file is invalid: {backup_path}") self.logger.error(f"Backup file is invalid: {backup_path}")
return False return False
try: try:
# Restore main config atomic_write_text(self.config_path, config_text)
shutil.copy2(backup_file, self.config_path)
self.logger.info(f"Restored config from backup: {backup_path}") self.logger.info(f"Restored config from backup: {backup_path}")
# Try to restore secrets backup if it exists secrets_backup_path = self._paired_secrets_backup(backup_file)
if self.secrets_path: if secrets_backup_path is not None and secrets_backup_path.exists():
# Look for corresponding secrets backup with open(secrets_backup_path, 'r') as f:
# Format: config_secrets.json.backup.TIMESTAMP atomic_write_text(self.secrets_path, f.read())
backup_name = backup_file.name
if '.backup.' in backup_name:
timestamp = backup_name.split('.backup.')[-1]
secrets_backup_name = f"{self.secrets_path.name}.backup.{timestamp}"
secrets_backup_path = self.backup_dir / secrets_backup_name
if secrets_backup_path.exists():
shutil.copy2(secrets_backup_path, self.secrets_path)
self.logger.info(f"Restored secrets from backup: {secrets_backup_path}") self.logger.info(f"Restored secrets from backup: {secrets_backup_path}")
return True return True
@@ -605,41 +636,23 @@ class AtomicConfigManager:
self.logger.error(f"Error during rollback: {e}", exc_info=True) self.logger.error(f"Error during rollback: {e}", exc_info=True)
return False return False
def _paired_secrets_backup(self, backup_file: Path) -> Optional[Path]:
"""The config_secrets.json.backup.<version> taken alongside a config backup."""
if not self.secrets_path or '.backup.' not in backup_file.name:
return None
version = backup_file.name.split('.backup.')[-1]
return self.backup_dir / f"{self.secrets_path.name}.backup.{version}"
def _rotate_backups(self) -> None: def _rotate_backups(self) -> None:
"""Remove old backups, keeping only the most recent N backups.""" """Remove old backups, keeping only the most recent N backups."""
backups = self.list_backups() for _, backup_file, _ in self._backup_entries()[self.max_backups:]:
if len(backups) <= self.max_backups:
return
# Sort by timestamp (oldest first) and remove excess
backups.sort(key=lambda b: b.timestamp)
backups_to_remove = backups[:-self.max_backups]
for backup in backups_to_remove:
try: try:
Path(backup.path).unlink() backup_file.unlink()
self.logger.debug(f"Removed old backup: {backup.path}") self.logger.debug(f"Removed old backup: {backup_file}")
# Also remove corresponding secrets backup if it exists secrets_backup_path = self._paired_secrets_backup(backup_file)
if self.secrets_path: if secrets_backup_path is not None and secrets_backup_path.exists():
backup_name = Path(backup.path).name
if '.backup.' in backup_name:
timestamp = backup_name.split('.backup.')[-1]
secrets_backup_name = f"{self.secrets_path.name}.backup.{timestamp}"
secrets_backup_path = self.backup_dir / secrets_backup_name
if secrets_backup_path.exists():
secrets_backup_path.unlink() secrets_backup_path.unlink()
except Exception as e: except Exception as e:
self.logger.warning(f"Error removing old backup {backup.path}: {e}") self.logger.warning(f"Error removing old backup {backup_file}: {e}")
def _cleanup_temp_files(self, *temp_paths: Path) -> None:
"""Clean up temporary files."""
for temp_path in temp_paths:
if temp_path and temp_path.exists():
try:
temp_path.unlink()
except Exception as e:
self.logger.warning(f"Error cleaning up temp file {temp_path}: {e}")
+347
View File
@@ -0,0 +1,347 @@
"""
Every write of config.json / config_secrets.json goes through one durable
writer, atomic_write_text() in src/config_manager_atomic.py: temp file in the
same directory, fsync, rename, directory fsync.
These pin what that buys on a device that loses power mid-save (the old file
survives intact), what it costs the SD card (the unchanged secrets file isn't
rewritten, backup rotation doesn't open every backup), and that the backups
it keeps are still the five config.json.backup.<version> files anything
restoring from them expects.
"""
import json
import os
import re
import stat
import threading
from pathlib import Path
import pytest
import src.config_manager_atomic as atomic_module
from src.config_manager import ConfigManager
from src.config_manager_atomic import AtomicConfigManager, SaveResultStatus, atomic_write_text
from src.exceptions import ConfigError
ORIGINAL = {"timezone": "America/Chicago", "display": {"hardware": {"rows": 32}}}
POSIX_ONLY = pytest.mark.skipif(os.name == 'nt', reason="POSIX file modes and directory fsync")
def make_manager(tmp_path, secrets=None):
config_file = tmp_path / "config.json"
config_file.write_text(json.dumps(ORIGINAL, indent=4))
secrets_file = tmp_path / "config_secrets.json"
if secrets is not None:
secrets_file.write_text(json.dumps(secrets, indent=4))
manager = ConfigManager(config_path=str(config_file), secrets_path=str(secrets_file))
manager.template_path = str(tmp_path / "no-template.json")
return manager
def temp_leftovers(directory):
return [p.name for p in Path(directory).iterdir() if '.tmp.' in p.name]
class TestPowerCutLeavesTheOldConfig:
"""A save that dies before the rename must leave config.json exactly as it was."""
def test_save_config_that_fails_midway_keeps_the_old_file(self, tmp_path):
# json.dump streams: an unencodable value deep in the dict used to
# leave config.json truncated at the point the encoder gave up.
manager = make_manager(tmp_path)
before = (tmp_path / "config.json").read_bytes()
with pytest.raises(ConfigError):
manager.save_config({"timezone": "UTC", "zzz": object()})
assert (tmp_path / "config.json").read_bytes() == before
assert temp_leftovers(tmp_path) == []
def test_save_config_that_dies_before_the_rename_keeps_the_old_file(self, tmp_path, monkeypatch):
manager = make_manager(tmp_path)
before = (tmp_path / "config.json").read_bytes()
def power_cut(*args, **kwargs):
raise OSError("power lost")
monkeypatch.setattr(atomic_module.os, "replace", power_cut)
with pytest.raises(ConfigError):
manager.save_config({"timezone": "UTC"})
assert (tmp_path / "config.json").read_bytes() == before
assert temp_leftovers(tmp_path) == []
def test_save_raw_file_content_that_dies_before_the_rename_keeps_the_old_file(self, tmp_path, monkeypatch):
manager = make_manager(tmp_path)
before = (tmp_path / "config.json").read_bytes()
def power_cut(*args, **kwargs):
raise OSError("power lost")
monkeypatch.setattr(atomic_module.os, "replace", power_cut)
with pytest.raises(ConfigError):
manager.save_raw_file_content("main", {"timezone": "UTC"})
assert (tmp_path / "config.json").read_bytes() == before
assert temp_leftovers(tmp_path) == []
def test_save_config_atomic_that_dies_before_the_rename_keeps_the_old_file(self, tmp_path, monkeypatch):
manager = make_manager(tmp_path)
before = json.loads((tmp_path / "config.json").read_text())
real_replace = os.replace
def power_cut(src, dst, *args, **kwargs):
if Path(dst).name == "config.json":
raise OSError("power lost")
return real_replace(src, dst, *args, **kwargs)
monkeypatch.setattr(atomic_module.os, "replace", power_cut)
result = manager.save_config_atomic({"timezone": "UTC"}, create_backup=False)
assert result.status == SaveResultStatus.FAILED
assert json.loads((tmp_path / "config.json").read_text()) == before
assert temp_leftovers(tmp_path) == []
class TestTheDataIsOnDiskBeforeTheRename:
def test_the_temp_file_is_fsynced_before_it_replaces_the_config(self, tmp_path, monkeypatch):
events = []
real_fsync, real_replace = os.fsync, os.replace
def fsync(fd):
events.append("fsync")
return real_fsync(fd)
def replace(src, dst, *args, **kwargs):
events.append("replace")
return real_replace(src, dst, *args, **kwargs)
monkeypatch.setattr(atomic_module.os, "fsync", fsync)
monkeypatch.setattr(atomic_module.os, "replace", replace)
make_manager(tmp_path).save_config({"timezone": "UTC"})
assert "replace" in events
assert "fsync" in events[:events.index("replace")]
assert json.loads((tmp_path / "config.json").read_text()) == {"timezone": "UTC"}
@POSIX_ONLY
def test_the_directory_is_fsynced_after_the_rename(self, tmp_path, monkeypatch):
events = []
real_fsync, real_replace, real_open = os.fsync, os.replace, os.open
directory_fds = set()
def open_(path, flags, *args, **kwargs):
fd = real_open(path, flags, *args, **kwargs)
if Path(path) == tmp_path:
directory_fds.add(fd)
return fd
def fsync(fd):
events.append("dir-fsync" if fd in directory_fds else "fsync")
return real_fsync(fd)
def replace(src, dst, *args, **kwargs):
events.append("replace")
return real_replace(src, dst, *args, **kwargs)
monkeypatch.setattr(atomic_module.os, "open", open_)
monkeypatch.setattr(atomic_module.os, "fsync", fsync)
monkeypatch.setattr(atomic_module.os, "replace", replace)
atomic_write_text(tmp_path / "config.json", "{}")
assert events == ["fsync", "replace", "dir-fsync"]
class TestPermissionsSurviveTheRename:
@POSIX_ONLY
def test_config_and_secrets_get_their_shared_modes_before_the_rename(self, tmp_path, monkeypatch):
# mkstemp creates 0600. If the chmod came after the rename, the other
# service could open the new file in between and be refused.
seen = {}
real_replace = os.replace
def replace(src, dst, *args, **kwargs):
seen[Path(dst).name] = stat.S_IMODE(os.stat(src).st_mode)
return real_replace(src, dst, *args, **kwargs)
monkeypatch.setattr(atomic_module.os, "replace", replace)
manager = make_manager(tmp_path, secrets={"weather": {"api_key": "k"}})
manager.save_raw_file_content("main", {"timezone": "UTC"})
manager.save_raw_file_content("secrets", {"weather": {"api_key": "new"}})
assert seen == {"config.json": 0o644, "config_secrets.json": 0o640}
assert stat.S_IMODE(os.stat(tmp_path / "config.json").st_mode) == 0o644
assert stat.S_IMODE(os.stat(tmp_path / "config_secrets.json").st_mode) == 0o640
@POSIX_ONLY
def test_a_directory_named_secrets_does_not_lock_down_config_json(self, tmp_path):
# get_config_file_mode() looks for "secrets" anywhere in the string it
# is given; handed the full path, an install under e.g.
# ~/secrets-lab/LEDMatrix made config.json 0o640.
directory = tmp_path / "secrets-lab"
directory.mkdir()
atomic_write_text(directory / "config.json", "{}")
assert stat.S_IMODE(os.stat(directory / "config.json").st_mode) == 0o644
def test_a_root_save_hands_the_file_back_to_its_previous_owner(self, tmp_path, monkeypatch):
# The display service runs as root. A rename gives the file to the
# writer, so without this a root save would leave config.json owned by
# root and the web user could only ever replace it, never edit it.
target = tmp_path / "config.json"
target.write_text("{}")
previous = target.stat()
chowns = []
monkeypatch.setattr(atomic_module.os, "geteuid", lambda: 0, raising=False)
monkeypatch.setattr(atomic_module.os, "chown",
lambda path, uid, gid: chowns.append((Path(path), uid, gid)),
raising=False)
monkeypatch.setattr("src.common.permission_utils.get_shared_group_gid", lambda: None)
atomic_write_text(target, '{"timezone": "UTC"}')
assert len(chowns) == 1
temp_path, uid, gid = chowns[0]
assert temp_path.parent == tmp_path and temp_path.name.startswith(".config.json.tmp.")
assert (uid, gid) == (previous.st_uid, previous.st_gid)
def test_a_non_root_save_never_tries_to_chown(self, tmp_path, monkeypatch):
target = tmp_path / "config.json"
target.write_text("{}")
chowns = []
monkeypatch.setattr(atomic_module.os, "geteuid", lambda: 1000, raising=False)
monkeypatch.setattr(atomic_module.os, "chown",
lambda *args: chowns.append(args), raising=False)
atomic_write_text(target, '{"timezone": "UTC"}')
assert chowns == []
@pytest.mark.skipif(os.name != 'nt', reason="only Windows refuses to rename over an open file")
class TestWindowsReaderHoldingTheFile:
def test_a_save_waits_out_a_reader_instead_of_failing(self, tmp_path):
target = tmp_path / "config.json"
target.write_text("{}")
reader = open(target)
closer = threading.Timer(0.15, reader.close)
closer.start()
try:
atomic_write_text(target, '{"timezone": "UTC"}')
finally:
closer.join()
reader.close()
assert json.loads(target.read_text()) == {"timezone": "UTC"}
class TestSecretsAreOnlyRewrittenWhenTheyChange:
@pytest.fixture
def writes(self, monkeypatch):
written = []
real = atomic_module.atomic_write_text
def spy(path, text, mode=None):
written.append(Path(path).name)
return real(path, text, mode)
monkeypatch.setattr(atomic_module, "atomic_write_text", spy)
return written
def test_config_manager_save_leaves_the_secrets_file_alone(self, tmp_path, writes):
secrets = {"weather": {"api_key": "k"}}
manager = make_manager(tmp_path, secrets=secrets)
config = manager.load_config()
config["timezone"] = "UTC"
result = manager.save_config_atomic(config)
assert result.status == SaveResultStatus.SUCCESS
assert writes == ["config.json"]
assert json.loads((tmp_path / "config_secrets.json").read_text()) == secrets
on_disk = json.loads((tmp_path / "config.json").read_text())
assert on_disk["timezone"] == "UTC" and "api_key" not in on_disk.get("weather", {})
def test_identical_secrets_are_not_rewritten(self, tmp_path, writes):
secrets = {"weather": {"api_key": "k"}}
make_manager(tmp_path, secrets=secrets)
manager = AtomicConfigManager(str(tmp_path / "config.json"),
str(tmp_path / "config_secrets.json"))
manager.save_config_atomic({"timezone": "UTC"}, new_secrets=dict(secrets))
assert writes == ["config.json"]
def test_changed_secrets_are_written(self, tmp_path, writes):
make_manager(tmp_path, secrets={"weather": {"api_key": "old"}})
manager = AtomicConfigManager(str(tmp_path / "config.json"),
str(tmp_path / "config_secrets.json"))
manager.save_config_atomic({"timezone": "UTC"}, new_secrets={"weather": {"api_key": "new"}})
assert writes == ["config.json", "config_secrets.json"]
assert json.loads((tmp_path / "config_secrets.json").read_text()) == {"weather": {"api_key": "new"}}
class TestBackupRotation:
VERSION = re.compile(r"^\d{8}_\d{6}_\d{6}(-\d+)?$")
def test_five_newest_backups_are_kept_under_the_same_names(self, tmp_path):
manager = make_manager(tmp_path, secrets={"weather": {"api_key": "k"}})
backup_dir = tmp_path / "backups"
backup_dir.mkdir()
for version in ("20240101_120000", "20240102_120000"):
(backup_dir / f"config.json.backup.{version}").write_text("{}")
(backup_dir / f"config_secrets.json.backup.{version}").write_text("{}")
created = []
for i in range(6):
result = manager.save_config_atomic({"timezone": f"tz{i}"})
assert result.status == SaveResultStatus.SUCCESS
created.append(Path(result.backup_path).name)
config_backups = sorted(p.name for p in backup_dir.glob("config.json.backup.*"))
secrets_backups = sorted(p.name for p in backup_dir.glob("config_secrets.json.backup.*"))
assert config_backups == sorted(created[-5:])
for name in config_backups:
assert self.VERSION.match(name[len("config.json.backup."):])
assert secrets_backups == sorted(
n.replace("config.json.backup.", "config_secrets.json.backup.") for n in created[-5:]
)
assert [b.path for b in manager.list_backups()] == [
str(backup_dir / n) for n in reversed(created[-5:])
]
def test_rotation_does_not_open_the_backups(self, tmp_path, monkeypatch):
manager = make_manager(tmp_path)
for _ in range(3):
manager.save_config_atomic({"timezone": "UTC"})
parsed = []
monkeypatch.setattr(AtomicConfigManager, "_validate_config_file",
lambda self, path: parsed.append(path))
result = manager.save_config_atomic({"timezone": "UTC"})
assert result.status == SaveResultStatus.SUCCESS
assert parsed == []
def test_a_rollback_still_restores_from_a_rotated_backup(self, tmp_path):
manager = make_manager(tmp_path)
for i in range(7):
manager.save_config_atomic({"timezone": f"tz{i}"})
assert manager.rollback_config()
# The newest backup was taken just before the last save.
assert json.loads((tmp_path / "config.json").read_text()) == {"timezone": "tz5"}