mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-03 09:48:06 +00:00
Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dd5bc93d87 | ||
|
|
512e38647a | ||
|
|
05e7c43b27 | ||
|
|
2ffc57cf40 | ||
|
|
aab0e9ade0 |
@@ -8,6 +8,7 @@ files that need to be accessible by both root service and web user.
|
|||||||
|
|
||||||
import os
|
import os
|
||||||
import logging
|
import logging
|
||||||
|
import re
|
||||||
import shutil as _shutil
|
import shutil as _shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
@@ -16,6 +17,25 @@ from typing import Optional
|
|||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
# Matches the credentials portion of a "scheme://user:pass@host" URL, so pip's
|
||||||
|
# own error output can be logged/displayed without echoing back a private
|
||||||
|
# index URL's embedded basic-auth secret verbatim (e.g. from a
|
||||||
|
# requirements.txt --index-url line or the PIP_INDEX_URL env var).
|
||||||
|
_URL_CREDENTIALS_RE = re.compile(r'://[^/\s@:]+:[^/\s@]+@')
|
||||||
|
|
||||||
|
|
||||||
|
def _redact_url_credentials(text: Optional[str]) -> str:
|
||||||
|
"""Replace embedded user:pass@ URL credentials in text with a placeholder.
|
||||||
|
|
||||||
|
Safe to call on any subprocess output destined for logs: it only ever
|
||||||
|
shortens/replaces the credential substring, never changes the presence
|
||||||
|
or absence of the specific fixed phrases callers check for
|
||||||
|
(e.g. "a password is required"), so it can't affect control flow.
|
||||||
|
"""
|
||||||
|
if not text:
|
||||||
|
return text or ""
|
||||||
|
return _URL_CREDENTIALS_RE.sub('://***:***@', text)
|
||||||
|
|
||||||
# System directories that should never have their permissions modified
|
# System directories that should never have their permissions modified
|
||||||
# These directories have special system-level permissions that must be preserved
|
# These directories have special system-level permissions that must be preserved
|
||||||
PROTECTED_SYSTEM_DIRECTORIES = { # nosec B108 - these are checked to PREVENT permission changes, not to use as temp paths
|
PROTECTED_SYSTEM_DIRECTORIES = { # nosec B108 - these are checked to PREVENT permission changes, not to use as temp paths
|
||||||
@@ -338,6 +358,13 @@ def install_requirements_file(req_file: Path, timeout: int = 300) -> subprocess.
|
|||||||
["sudo", "-n", bash_path, str(wrapper), str(req_file)],
|
["sudo", "-n", bash_path, str(wrapper), str(req_file)],
|
||||||
capture_output=True, text=True, timeout=timeout, cwd=str(project_root)
|
capture_output=True, text=True, timeout=timeout, cwd=str(project_root)
|
||||||
)
|
)
|
||||||
|
# Redact immediately: pip can echo a private index URL's embedded
|
||||||
|
# basic-auth credentials back in its own error/progress output
|
||||||
|
# (e.g. from a requirements.txt --index-url line). Doesn't affect
|
||||||
|
# the fixed-phrase "denied" check below -- those phrases never
|
||||||
|
# overlap with URL syntax.
|
||||||
|
result.stderr = _redact_url_credentials(result.stderr)
|
||||||
|
result.stdout = _redact_url_credentials(result.stdout)
|
||||||
if result.returncode == 0:
|
if result.returncode == 0:
|
||||||
return result
|
return result
|
||||||
# Distinguish "sudo rejected this exact command line" (worth
|
# Distinguish "sudo rejected this exact command line" (worth
|
||||||
@@ -348,16 +375,24 @@ def install_requirements_file(req_file: Path, timeout: int = 300) -> subprocess.
|
|||||||
for phrase in ("a password is required", "is not allowed to run", "no tty present")
|
for phrase in ("a password is required", "is not allowed to run", "no tty present")
|
||||||
)
|
)
|
||||||
if not denied:
|
if not denied:
|
||||||
|
# Deliberately don't interpolate req_file or the pip output here:
|
||||||
|
# this log line is scanner-visible, and a static analyzer can't
|
||||||
|
# tell "already redacted above" from "still raw" just by looking
|
||||||
|
# at this call in isolation. The full (redacted) text is still
|
||||||
|
# available to callers via the returned CompletedProcess.
|
||||||
logger.warning(
|
logger.warning(
|
||||||
"Root pip install failed (rc=%s) for %s: %s",
|
"Root pip install failed (rc=%s); see the returned "
|
||||||
result.returncode, req_file, result.stderr.strip()[:500],
|
"CompletedProcess.stderr for details.",
|
||||||
|
result.returncode,
|
||||||
)
|
)
|
||||||
return result
|
return result
|
||||||
|
|
||||||
|
# Same reasoning as above: no req_file / pip-output interpolation in
|
||||||
|
# this log line, only in the returned note/CompletedProcess.
|
||||||
logger.warning(
|
logger.warning(
|
||||||
"Root pip install wrapper denied via sudo for %s; falling back to "
|
"Root pip install wrapper denied via sudo for all candidates; "
|
||||||
"user-level install: %s",
|
"falling back to user-level install. See the returned "
|
||||||
req_file, result.stderr.strip()[:500] if result else "no bash candidates found",
|
"CompletedProcess.stderr for details."
|
||||||
)
|
)
|
||||||
note = (
|
note = (
|
||||||
f"[Root install unavailable ({(result.stderr.strip() if result else 'sudo denied') or 'sudo denied'}); "
|
f"[Root install unavailable ({(result.stderr.strip() if result else 'sudo denied') or 'sudo denied'}); "
|
||||||
@@ -367,8 +402,7 @@ def install_requirements_file(req_file: Path, timeout: int = 300) -> subprocess.
|
|||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
logger.warning(
|
logger.warning(
|
||||||
"safe_pip_install.sh not found; falling back to user-level install for %s",
|
"safe_pip_install.sh not found; falling back to user-level install."
|
||||||
req_file,
|
|
||||||
)
|
)
|
||||||
note = (
|
note = (
|
||||||
"[safe_pip_install.sh not found; installed for the current process's "
|
"[safe_pip_install.sh not found; installed for the current process's "
|
||||||
@@ -386,6 +420,7 @@ def install_requirements_file(req_file: Path, timeout: int = 300) -> subprocess.
|
|||||||
[sys.executable, "-m", "pip", "install", "--break-system-packages", "--ignore-installed", "-r", str(req_file)],
|
[sys.executable, "-m", "pip", "install", "--break-system-packages", "--ignore-installed", "-r", str(req_file)],
|
||||||
capture_output=True, text=True, timeout=timeout, cwd=str(project_root)
|
capture_output=True, text=True, timeout=timeout, cwd=str(project_root)
|
||||||
)
|
)
|
||||||
result.stdout = note + (result.stdout or "")
|
result.stderr = _redact_url_credentials(result.stderr)
|
||||||
|
result.stdout = note + _redact_url_credentials(result.stdout)
|
||||||
return result
|
return result
|
||||||
|
|
||||||
|
|||||||
@@ -199,6 +199,10 @@ class DisplayController:
|
|||||||
self.wifi_status_file = WIFI_STATUS_FILE
|
self.wifi_status_file = WIFI_STATUS_FILE
|
||||||
self.wifi_status_active = False
|
self.wifi_status_active = False
|
||||||
self.wifi_status_expires_at: Optional[float] = None
|
self.wifi_status_expires_at: Optional[float] = None
|
||||||
|
# _check_wifi_status_message throttle state (checked at frame rate,
|
||||||
|
# stat'd at most once per second)
|
||||||
|
self._wifi_status_check_ts = 0.0
|
||||||
|
self._wifi_status_last_result: Optional[Dict[str, Any]] = None
|
||||||
|
|
||||||
# Plugin display() signature cache — must be initialised before the plugin
|
# Plugin display() signature cache — must be initialised before the plugin
|
||||||
# loading loop below so the .pop() invalidation at load time is always safe.
|
# loading loop below so the .pop() invalidation at load time is always safe.
|
||||||
@@ -1635,7 +1639,7 @@ class DisplayController:
|
|||||||
self._sleep_with_plugin_updates(60)
|
self._sleep_with_plugin_updates(60)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
logger.info(f"Display active, processing mode: {self.current_display_mode}")
|
logger.debug("Display active, processing mode: %s", self.current_display_mode)
|
||||||
|
|
||||||
# Plugins update on their own schedules - no forced sync updates needed
|
# Plugins update on their own schedules - no forced sync updates needed
|
||||||
# Each plugin has its own update_interval and background services
|
# Each plugin has its own update_interval and background services
|
||||||
@@ -1803,7 +1807,7 @@ class DisplayController:
|
|||||||
if self.plugin_manager and hasattr(self.plugin_manager, 'health_tracker') and self.plugin_manager.health_tracker:
|
if self.plugin_manager and hasattr(self.plugin_manager, 'health_tracker') and self.plugin_manager.health_tracker:
|
||||||
should_skip = self.plugin_manager.health_tracker.should_skip_plugin(plugin_id)
|
should_skip = self.plugin_manager.health_tracker.should_skip_plugin(plugin_id)
|
||||||
if should_skip:
|
if should_skip:
|
||||||
logger.info(f"Skipping plugin {plugin_id} due to circuit breaker (mode: {active_mode})")
|
logger.info("Skipping plugin %s due to circuit breaker (mode: %s)", plugin_id, active_mode)
|
||||||
display_result = False
|
display_result = False
|
||||||
# Skip to next mode - let existing logic handle it
|
# Skip to next mode - let existing logic handle it
|
||||||
manager_to_display = None
|
manager_to_display = None
|
||||||
@@ -1861,7 +1865,7 @@ class DisplayController:
|
|||||||
if isinstance(result, bool):
|
if isinstance(result, bool):
|
||||||
display_result = result
|
display_result = result
|
||||||
if not display_result:
|
if not display_result:
|
||||||
logger.info(f"Plugin {plugin_id} display() returned False for mode {active_mode}")
|
logger.info("Plugin %s display() returned False for mode %s", plugin_id, active_mode)
|
||||||
|
|
||||||
# Record success if display completed without exception
|
# Record success if display completed without exception
|
||||||
if self.plugin_manager and hasattr(self.plugin_manager, 'health_tracker') and self.plugin_manager.health_tracker:
|
if self.plugin_manager and hasattr(self.plugin_manager, 'health_tracker') and self.plugin_manager.health_tracker:
|
||||||
@@ -2354,6 +2358,16 @@ class DisplayController:
|
|||||||
Returns None on any error or if message is expired/invalid.
|
Returns None on any error or if message is expired/invalid.
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
|
# Throttle the existence stat to ~1 Hz: this runs on every render
|
||||||
|
# iteration (60+ fps), and the file usually doesn't exist — the
|
||||||
|
# status message's lifetime is measured in seconds anyway.
|
||||||
|
# Both attributes are initialised in __init__.
|
||||||
|
now = time.time()
|
||||||
|
if (now - self._wifi_status_check_ts) < 1.0:
|
||||||
|
return self._wifi_status_last_result
|
||||||
|
self._wifi_status_check_ts = now
|
||||||
|
self._wifi_status_last_result = None
|
||||||
|
|
||||||
# Check if file exists
|
# Check if file exists
|
||||||
if not self.wifi_status_file or not self.wifi_status_file.exists():
|
if not self.wifi_status_file or not self.wifi_status_file.exists():
|
||||||
return None
|
return None
|
||||||
@@ -2404,13 +2418,14 @@ class DisplayController:
|
|||||||
pass
|
pass
|
||||||
return None
|
return None
|
||||||
|
|
||||||
# Message is valid and not expired
|
# Message is valid and not expired — cache for the throttle window
|
||||||
return {
|
self._wifi_status_last_result = {
|
||||||
'message': message,
|
'message': message,
|
||||||
'timestamp': timestamp,
|
'timestamp': timestamp,
|
||||||
'duration': duration,
|
'duration': duration,
|
||||||
'expires_at': expires_at
|
'expires_at': expires_at
|
||||||
}
|
}
|
||||||
|
return self._wifi_status_last_result
|
||||||
|
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
# Catch-all for any unexpected errors - log but don't break the display
|
# Catch-all for any unexpected errors - log but don't break the display
|
||||||
|
|||||||
@@ -93,6 +93,27 @@ def requirements_are_satisfied(requirements_file: str) -> bool:
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def find_trusted_subdir(trusted_dir: str, name: str) -> Optional[str]:
|
||||||
|
"""Return `name` if it names an actual subdirectory of trusted_dir, else None.
|
||||||
|
|
||||||
|
Used as a containment check for a directory name derived from untrusted
|
||||||
|
input (a manifest-declared plugin id, an externally-supplied plugin
|
||||||
|
path): the returned value always comes from enumerating trusted_dir
|
||||||
|
itself via os.scandir(), so a caller that builds a path by joining
|
||||||
|
trusted_dir with this return value is joining against a name the
|
||||||
|
filesystem produced under a trusted root -- not the caller's original
|
||||||
|
string, which could otherwise smuggle a traversal sequence through.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
with os.scandir(trusted_dir) as entries:
|
||||||
|
for entry in entries:
|
||||||
|
if entry.name == name and entry.is_dir():
|
||||||
|
return entry.name
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
class PluginLoader:
|
class PluginLoader:
|
||||||
"""Handles plugin module loading and class instantiation."""
|
"""Handles plugin module loading and class instantiation."""
|
||||||
|
|
||||||
@@ -207,7 +228,7 @@ class PluginLoader:
|
|||||||
self,
|
self,
|
||||||
plugin_dir: Path,
|
plugin_dir: Path,
|
||||||
plugin_id: str,
|
plugin_id: str,
|
||||||
plugins_dir: Optional[Path] = None,
|
plugins_dir: Path,
|
||||||
timeout: int = 300
|
timeout: int = 300
|
||||||
) -> bool:
|
) -> bool:
|
||||||
"""
|
"""
|
||||||
@@ -216,7 +237,12 @@ class PluginLoader:
|
|||||||
Args:
|
Args:
|
||||||
plugin_dir: Plugin directory path
|
plugin_dir: Plugin directory path
|
||||||
plugin_id: Plugin identifier
|
plugin_id: Plugin identifier
|
||||||
plugins_dir: Trusted base plugins directory for path containment check
|
plugins_dir: Trusted base plugins directory for path containment check.
|
||||||
|
Required (not optional) so every caller reconstructs the plugin
|
||||||
|
path through the sanitiser below rather than trusting plugin_dir
|
||||||
|
directly -- CodeQL's path-injection query (and a malicious
|
||||||
|
manifest/plugin_id in practice) can't tell a legitimate
|
||||||
|
plugin_dir from one crafted to traverse outside plugins_dir.
|
||||||
timeout: Installation timeout in seconds
|
timeout: Installation timeout in seconds
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
@@ -228,31 +254,24 @@ class PluginLoader:
|
|||||||
|
|
||||||
# Resolve to a canonical absolute path (normalises .. and symlinks)
|
# Resolve to a canonical absolute path (normalises .. and symlinks)
|
||||||
plugin_dir_real = os.path.realpath(str(plugin_dir))
|
plugin_dir_real = os.path.realpath(str(plugin_dir))
|
||||||
|
|
||||||
if plugins_dir is not None:
|
|
||||||
# Reconstruct the plugin path from a trusted base + a sanitised
|
|
||||||
# directory name. os.path.basename() is CodeQL's recognised
|
|
||||||
# py/path-injection sanitiser: it strips all directory components
|
|
||||||
# so the result cannot contain traversal sequences. Joining it
|
|
||||||
# with the resolved, trusted plugins_dir produces a path that
|
|
||||||
# CodeQL considers untainted.
|
|
||||||
plugins_dir_real = os.path.realpath(str(plugins_dir))
|
plugins_dir_real = os.path.realpath(str(plugins_dir))
|
||||||
safe_dir_name = os.path.basename(plugin_dir_real)
|
requested_name = os.path.basename(plugin_dir_real)
|
||||||
if not safe_dir_name:
|
|
||||||
self.logger.error("Could not determine plugin directory name for %s", plugin_id)
|
# Match the requested directory against an entry actually enumerated
|
||||||
return False
|
# from the trusted plugins_dir, and build the path from that entry --
|
||||||
safe_plugin_dir = os.path.join(plugins_dir_real, safe_dir_name)
|
# not from requested_name. A name that came out of os.scandir() on a
|
||||||
if not os.path.isdir(safe_plugin_dir):
|
# trusted root carries no taint regardless of what the caller asked
|
||||||
|
# for, so this is a real containment guarantee (an allowlist check
|
||||||
|
# against a trusted source), not a string-sanitisation of untrusted
|
||||||
|
# input that a static analyzer has to trust blindly.
|
||||||
|
matched_name = find_trusted_subdir(plugins_dir_real, requested_name)
|
||||||
|
if matched_name is None:
|
||||||
self.logger.error(
|
self.logger.error(
|
||||||
"Plugin directory for %s not found inside plugins dir", plugin_id
|
"Plugin directory for %s not found inside plugins dir", plugin_id
|
||||||
)
|
)
|
||||||
return False
|
return False
|
||||||
else:
|
|
||||||
safe_plugin_dir = plugin_dir_real
|
|
||||||
if not os.path.isdir(safe_plugin_dir):
|
|
||||||
self.logger.error("Plugin directory does not exist: %s", plugin_dir)
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
safe_plugin_dir = os.path.join(plugins_dir_real, matched_name)
|
||||||
requirements_file = os.path.join(safe_plugin_dir, "requirements.txt")
|
requirements_file = os.path.join(safe_plugin_dir, "requirements.txt")
|
||||||
|
|
||||||
if not os.path.isfile(requirements_file):
|
if not os.path.isfile(requirements_file):
|
||||||
@@ -698,6 +717,14 @@ class PluginLoader:
|
|||||||
"""
|
"""
|
||||||
# Install dependencies if needed
|
# Install dependencies if needed
|
||||||
if install_deps:
|
if install_deps:
|
||||||
|
if plugins_dir is None:
|
||||||
|
raise PluginError(
|
||||||
|
f"plugins_dir is required to install dependencies for plugin {plugin_id} "
|
||||||
|
"(needed for path containment; pass install_deps=False if the caller "
|
||||||
|
"doesn't have a trusted plugins directory to supply)",
|
||||||
|
plugin_id=plugin_id,
|
||||||
|
context={'plugin_dir': str(plugin_dir)},
|
||||||
|
)
|
||||||
if not self.install_dependencies(plugin_dir, plugin_id, plugins_dir=plugins_dir):
|
if not self.install_dependencies(plugin_dir, plugin_id, plugins_dir=plugins_dir):
|
||||||
raise PluginError(
|
raise PluginError(
|
||||||
f"Dependency installation failed for plugin {plugin_id} in {plugin_dir}",
|
f"Dependency installation failed for plugin {plugin_id} in {plugin_dir}",
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import json
|
|||||||
import sys
|
import sys
|
||||||
import time
|
import time
|
||||||
import threading
|
import threading
|
||||||
|
import types
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Dict, List, Optional, Any
|
from typing import Dict, List, Optional, Any
|
||||||
import logging
|
import logging
|
||||||
@@ -743,8 +744,18 @@ class PluginManager:
|
|||||||
# If resource monitor exists, wrap the call
|
# If resource monitor exists, wrap the call
|
||||||
def monitored_update():
|
def monitored_update():
|
||||||
self.resource_monitor.monitor_call(plugin_id, plugin_instance.update)
|
self.resource_monitor.monitor_call(plugin_id, plugin_instance.update)
|
||||||
|
# SimpleNamespace stores `update` as an *instance*
|
||||||
|
# attribute, so attribute lookup returns the plain
|
||||||
|
# function object as-is. A dynamically-built class
|
||||||
|
# (`type(..., {'update': monitored_update})`) instead
|
||||||
|
# stores it as a *class* attribute, which the
|
||||||
|
# descriptor protocol turns into a bound method on
|
||||||
|
# access -- silently prepending the instance as an
|
||||||
|
# implicit first argument to a function that takes
|
||||||
|
# none, raising "monitored_update() takes 0
|
||||||
|
# positional arguments but 1 was given" on every call.
|
||||||
success = self.plugin_executor.execute_update(
|
success = self.plugin_executor.execute_update(
|
||||||
type('obj', (object,), {'update': monitored_update})(),
|
types.SimpleNamespace(update=monitored_update),
|
||||||
plugin_id
|
plugin_id
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -25,7 +25,9 @@ import logging
|
|||||||
from urllib.parse import urlparse
|
from urllib.parse import urlparse
|
||||||
|
|
||||||
from src.common.permission_utils import sudo_remove_directory, install_requirements_file
|
from src.common.permission_utils import sudo_remove_directory, install_requirements_file
|
||||||
from src.plugin_system.plugin_loader import requirements_has_real_deps, requirements_are_satisfied
|
from src.plugin_system.plugin_loader import (
|
||||||
|
requirements_has_real_deps, requirements_are_satisfied, find_trusted_subdir
|
||||||
|
)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from jsonschema import Draft7Validator, ValidationError
|
from jsonschema import Draft7Validator, ValidationError
|
||||||
@@ -1907,7 +1909,25 @@ class PluginStoreManager:
|
|||||||
Returns:
|
Returns:
|
||||||
True if successful or no requirements file
|
True if successful or no requirements file
|
||||||
"""
|
"""
|
||||||
requirements_file = plugin_path / "requirements.txt"
|
# Reconstruct the plugin path from the trusted self.plugins_dir base +
|
||||||
|
# an entry actually enumerated from it, rather than trusting
|
||||||
|
# plugin_path directly -- callers ultimately derive it from a
|
||||||
|
# plugin-supplied manifest "id" field (see install_plugin_from_url),
|
||||||
|
# so without this a malicious manifest could point requirements_file
|
||||||
|
# outside plugins_dir. find_trusted_subdir()'s return value always
|
||||||
|
# comes from os.scandir() on the trusted root, so building the path
|
||||||
|
# from it (not from the caller's string) is a real containment
|
||||||
|
# guarantee, matching the pattern in PluginLoader.install_dependencies().
|
||||||
|
plugin_dir_real = os.path.realpath(str(plugin_path))
|
||||||
|
plugins_dir_real = os.path.realpath(str(self.plugins_dir))
|
||||||
|
requested_name = os.path.basename(plugin_dir_real)
|
||||||
|
matched_name = find_trusted_subdir(plugins_dir_real, requested_name)
|
||||||
|
if matched_name is None:
|
||||||
|
self.logger.error("Plugin directory not found inside plugins dir for dependency install")
|
||||||
|
return False
|
||||||
|
safe_plugin_path = Path(os.path.join(plugins_dir_real, matched_name))
|
||||||
|
|
||||||
|
requirements_file = safe_plugin_path / "requirements.txt"
|
||||||
|
|
||||||
if not requirements_file.exists():
|
if not requirements_file.exists():
|
||||||
self.logger.debug(f"No requirements.txt found in {plugin_path.name}")
|
self.logger.debug(f"No requirements.txt found in {plugin_path.name}")
|
||||||
|
|||||||
@@ -454,6 +454,18 @@ class VisualTestDisplayManager:
|
|||||||
"""Check if display is currently scrolling."""
|
"""Check if display is currently scrolling."""
|
||||||
return self._scrolling_state['is_scrolling']
|
return self._scrolling_state['is_scrolling']
|
||||||
|
|
||||||
|
def process_deferred_updates(self):
|
||||||
|
"""Process any deferred updates (no-op for testing).
|
||||||
|
|
||||||
|
Several ticker-style plugins (news, odds-ticker, leaderboard,
|
||||||
|
stock-news, stocks) call this unconditionally between
|
||||||
|
set_scrolling_state() and their scroll-position update, mirroring the
|
||||||
|
real display_manager's deferred-update queue. This double has no such
|
||||||
|
queue, so there is nothing to process — the no-op just lets those
|
||||||
|
plugins render under the harness instead of raising AttributeError.
|
||||||
|
"""
|
||||||
|
pass
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
# Utility methods
|
# Utility methods
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
|
|||||||
@@ -66,6 +66,10 @@ class RenderPipeline:
|
|||||||
else display_manager.height
|
else display_manager.height
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Reusable blank frame for cycle-end pushes (allocated lazily,
|
||||||
|
# re-blacked before each reuse)
|
||||||
|
self._blank_frame = None
|
||||||
|
|
||||||
# ScrollHelper for optimized scrolling
|
# ScrollHelper for optimized scrolling
|
||||||
self.scroll_helper = ScrollHelper(
|
self.scroll_helper = ScrollHelper(
|
||||||
self.display_width,
|
self.display_width,
|
||||||
@@ -234,11 +238,19 @@ class RenderPipeline:
|
|||||||
)
|
)
|
||||||
# Push blank immediately so the hardware never shows any
|
# Push blank immediately so the hardware never shows any
|
||||||
# post-wrap content while the coordinator recomposes the
|
# post-wrap content while the coordinator recomposes the
|
||||||
# next cycle (~100 ms).
|
# next cycle (~100 ms). The blank is allocated once and
|
||||||
|
# reused across cycle wraps (fresh paste each time in case
|
||||||
|
# a consumer drew on the previous one).
|
||||||
try:
|
try:
|
||||||
from PIL import Image as _Image
|
if self._blank_frame is None or self._blank_frame.size != (
|
||||||
blank = _Image.new('RGB', (self.display_width, self.display_height))
|
self.display_width, self.display_height):
|
||||||
self.display_manager.image = blank
|
self._blank_frame = Image.new(
|
||||||
|
'RGB', (self.display_width, self.display_height))
|
||||||
|
else:
|
||||||
|
self._blank_frame.paste(
|
||||||
|
(0, 0, 0),
|
||||||
|
(0, 0, self.display_width, self.display_height))
|
||||||
|
self.display_manager.image = self._blank_frame
|
||||||
self.display_manager.update_display()
|
self.display_manager.update_display()
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("Failed to write blank frame to display at cycle end")
|
logger.exception("Failed to write blank frame to display at cycle end")
|
||||||
|
|||||||
@@ -172,6 +172,16 @@ class TestVisualDisplayManager:
|
|||||||
vdm.set_scrolling_state(False)
|
vdm.set_scrolling_state(False)
|
||||||
assert vdm.is_currently_scrolling() is False
|
assert vdm.is_currently_scrolling() is False
|
||||||
|
|
||||||
|
def test_process_deferred_updates_is_noop(self):
|
||||||
|
# Ticker-style plugins (news, odds-ticker, leaderboard, stock-news,
|
||||||
|
# stocks) call this unconditionally alongside set_scrolling_state();
|
||||||
|
# it must exist and be harmless so those plugins render under the
|
||||||
|
# harness instead of raising AttributeError.
|
||||||
|
vdm = VisualTestDisplayManager(width=128, height=32)
|
||||||
|
vdm.set_scrolling_state(True)
|
||||||
|
vdm.process_deferred_updates() # should not raise
|
||||||
|
assert vdm.is_currently_scrolling() is True
|
||||||
|
|
||||||
def test_format_date_with_ordinal(self):
|
def test_format_date_with_ordinal(self):
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
vdm = VisualTestDisplayManager(width=128, height=32)
|
vdm = VisualTestDisplayManager(width=128, height=32)
|
||||||
|
|||||||
@@ -0,0 +1,83 @@
|
|||||||
|
"""
|
||||||
|
Tests for src.common.permission_utils's URL-credential redaction.
|
||||||
|
|
||||||
|
Covers the fix for a CodeQL clear-text-logging-of-secrets alert:
|
||||||
|
install_requirements_file() must never let a private index URL's embedded
|
||||||
|
user:pass@ credentials reach logs or its returned CompletedProcess, since
|
||||||
|
pip can echo that URL back verbatim in its own stderr/stdout on failure.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
from src.common.permission_utils import _redact_url_credentials, install_requirements_file
|
||||||
|
|
||||||
|
|
||||||
|
class TestRedactUrlCredentials:
|
||||||
|
def test_redacts_embedded_basic_auth(self):
|
||||||
|
text = "Could not fetch URL https://alice:s3cr3t@pypi.example.com/simple/: 403"
|
||||||
|
redacted = _redact_url_credentials(text)
|
||||||
|
assert "s3cr3t" not in redacted
|
||||||
|
assert "alice" not in redacted
|
||||||
|
assert "https://***:***@pypi.example.com/simple/" in redacted
|
||||||
|
|
||||||
|
def test_leaves_credential_free_text_unchanged(self):
|
||||||
|
text = "ERROR: Could not find a version that satisfies the requirement foo==1.0"
|
||||||
|
assert _redact_url_credentials(text) == text
|
||||||
|
|
||||||
|
def test_handles_none_and_empty(self):
|
||||||
|
assert _redact_url_credentials(None) == ""
|
||||||
|
assert _redact_url_credentials("") == ""
|
||||||
|
|
||||||
|
def test_does_not_touch_denied_check_phrases(self):
|
||||||
|
"""The fixed phrases install_requirements_file greps for must survive
|
||||||
|
redaction untouched -- they don't overlap with URL syntax, but this
|
||||||
|
pins that assumption so a regex change can't silently break it."""
|
||||||
|
text = "sudo: a password is required"
|
||||||
|
assert _redact_url_credentials(text) == text
|
||||||
|
|
||||||
|
|
||||||
|
class TestInstallRequirementsFileRedaction:
|
||||||
|
@patch('src.common.permission_utils.subprocess.run')
|
||||||
|
def test_wrapper_path_redacts_stderr_and_stdout(self, mock_run, tmp_path):
|
||||||
|
"""safe_pip_install.sh exists in this repo, so install_requirements_file
|
||||||
|
takes the sudo-wrapper branch; a failing result must come back
|
||||||
|
with any embedded index-URL credentials already redacted."""
|
||||||
|
req_file = tmp_path / "requirements.txt"
|
||||||
|
req_file.write_text("requests\n")
|
||||||
|
|
||||||
|
mock_run.return_value = MagicMock(
|
||||||
|
returncode=1,
|
||||||
|
stdout="Looking in indexes: https://bob:hunter2@pypi.internal/simple\n",
|
||||||
|
stderr="ERROR https://bob:hunter2@pypi.internal/simple/foo: 401",
|
||||||
|
)
|
||||||
|
|
||||||
|
result = install_requirements_file(req_file, timeout=5)
|
||||||
|
|
||||||
|
assert "hunter2" not in result.stdout
|
||||||
|
assert "hunter2" not in result.stderr
|
||||||
|
assert "https://***:***@pypi.internal" in result.stdout
|
||||||
|
assert "https://***:***@pypi.internal" in result.stderr
|
||||||
|
|
||||||
|
@patch('src.common.permission_utils.subprocess.run')
|
||||||
|
@patch('src.common.permission_utils.Path.exists', return_value=False)
|
||||||
|
def test_no_wrapper_fallback_path_redacts_stderr_and_stdout(self, mock_exists, mock_run, tmp_path):
|
||||||
|
"""No safe_pip_install.sh wrapper -> falls straight to the
|
||||||
|
sys.executable pip fallback (the second subprocess.run call site);
|
||||||
|
its result must come back redacted too, independent of the wrapper
|
||||||
|
branch's own redaction above."""
|
||||||
|
req_file = tmp_path / "requirements.txt"
|
||||||
|
req_file.write_text("requests\n")
|
||||||
|
|
||||||
|
mock_run.return_value = MagicMock(
|
||||||
|
returncode=1,
|
||||||
|
stdout="Looking in indexes: https://carol:swordfish@pypi.internal/simple\n",
|
||||||
|
stderr="ERROR https://carol:swordfish@pypi.internal/simple/foo: 401",
|
||||||
|
)
|
||||||
|
|
||||||
|
result = install_requirements_file(req_file, timeout=5)
|
||||||
|
|
||||||
|
assert "swordfish" not in result.stdout
|
||||||
|
assert "swordfish" not in result.stderr
|
||||||
|
assert "https://***:***@pypi.internal" in result.stdout
|
||||||
|
assert "https://***:***@pypi.internal" in result.stderr
|
||||||
@@ -193,7 +193,7 @@ class TestPluginLoader:
|
|||||||
|
|
||||||
mock_subprocess.return_value = MagicMock(returncode=0)
|
mock_subprocess.return_value = MagicMock(returncode=0)
|
||||||
|
|
||||||
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin")
|
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin", plugins_dir=tmp_plugins_dir)
|
||||||
|
|
||||||
assert result is True
|
assert result is True
|
||||||
mock_subprocess.assert_called_once()
|
mock_subprocess.assert_called_once()
|
||||||
@@ -204,7 +204,7 @@ class TestPluginLoader:
|
|||||||
plugin_dir = tmp_plugins_dir / "test_plugin"
|
plugin_dir = tmp_plugins_dir / "test_plugin"
|
||||||
plugin_dir.mkdir()
|
plugin_dir.mkdir()
|
||||||
|
|
||||||
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin")
|
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin", plugins_dir=tmp_plugins_dir)
|
||||||
|
|
||||||
assert result is True
|
assert result is True
|
||||||
mock_subprocess.assert_not_called()
|
mock_subprocess.assert_not_called()
|
||||||
@@ -219,7 +219,7 @@ class TestPluginLoader:
|
|||||||
|
|
||||||
mock_subprocess.return_value = MagicMock(returncode=1)
|
mock_subprocess.return_value = MagicMock(returncode=1)
|
||||||
|
|
||||||
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin")
|
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin", plugins_dir=tmp_plugins_dir)
|
||||||
|
|
||||||
assert result is False
|
assert result is False
|
||||||
|
|
||||||
@@ -245,7 +245,7 @@ class TestPluginLoader:
|
|||||||
retry_attempt = MagicMock(returncode=0, stderr="")
|
retry_attempt = MagicMock(returncode=0, stderr="")
|
||||||
mock_subprocess.side_effect = [first_attempt, retry_attempt]
|
mock_subprocess.side_effect = [first_attempt, retry_attempt]
|
||||||
|
|
||||||
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin")
|
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin", plugins_dir=tmp_plugins_dir)
|
||||||
|
|
||||||
assert result is True
|
assert result is True
|
||||||
assert mock_subprocess.call_count == 2
|
assert mock_subprocess.call_count == 2
|
||||||
@@ -271,7 +271,7 @@ class TestPluginLoader:
|
|||||||
retry_attempt = MagicMock(returncode=1, stderr="some other pip error")
|
retry_attempt = MagicMock(returncode=1, stderr="some other pip error")
|
||||||
mock_subprocess.side_effect = [first_attempt, retry_attempt]
|
mock_subprocess.side_effect = [first_attempt, retry_attempt]
|
||||||
|
|
||||||
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin")
|
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin", plugins_dir=tmp_plugins_dir)
|
||||||
|
|
||||||
assert result is True
|
assert result is True
|
||||||
assert mock_subprocess.call_count == 2
|
assert mock_subprocess.call_count == 2
|
||||||
@@ -298,7 +298,7 @@ class TestPluginLoader:
|
|||||||
subprocess.TimeoutExpired(cmd="pip", timeout=300),
|
subprocess.TimeoutExpired(cmd="pip", timeout=300),
|
||||||
]
|
]
|
||||||
|
|
||||||
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin")
|
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin", plugins_dir=tmp_plugins_dir)
|
||||||
|
|
||||||
assert result is True
|
assert result is True
|
||||||
assert mock_subprocess.call_count == 2
|
assert mock_subprocess.call_count == 2
|
||||||
@@ -311,7 +311,34 @@ class TestPluginLoader:
|
|||||||
requirements_file = plugin_dir / "requirements.txt"
|
requirements_file = plugin_dir / "requirements.txt"
|
||||||
requirements_file.write_text("pytest>=1.0\n")
|
requirements_file.write_text("pytest>=1.0\n")
|
||||||
|
|
||||||
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin")
|
result = plugin_loader.install_dependencies(plugin_dir, "test_plugin", plugins_dir=tmp_plugins_dir)
|
||||||
|
|
||||||
assert result is True
|
assert result is True
|
||||||
mock_subprocess.assert_not_called()
|
mock_subprocess.assert_not_called()
|
||||||
|
|
||||||
|
def test_install_dependencies_requires_plugins_dir(self, plugin_loader, tmp_plugins_dir):
|
||||||
|
"""plugins_dir is a required argument, not an optional trust-me flag --
|
||||||
|
calling without it must fail loudly (TypeError) rather than silently
|
||||||
|
falling back to trusting plugin_dir unchecked."""
|
||||||
|
plugin_dir = tmp_plugins_dir / "test_plugin"
|
||||||
|
plugin_dir.mkdir()
|
||||||
|
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
plugin_loader.install_dependencies(plugin_dir, "test_plugin")
|
||||||
|
|
||||||
|
@patch('subprocess.run')
|
||||||
|
def test_install_dependencies_rejects_path_outside_plugins_dir(
|
||||||
|
self, mock_subprocess, plugin_loader, tmp_path, tmp_plugins_dir
|
||||||
|
):
|
||||||
|
"""A plugin_dir that doesn't actually live inside plugins_dir (e.g. a
|
||||||
|
manifest-derived id crafted to traverse elsewhere) must be rejected
|
||||||
|
rather than read from -- this is the path-injection containment
|
||||||
|
check CodeQL flagged as missing."""
|
||||||
|
outside_dir = tmp_path / "outside"
|
||||||
|
outside_dir.mkdir()
|
||||||
|
(outside_dir / "requirements.txt").write_text("requests>=2.0\n")
|
||||||
|
|
||||||
|
result = plugin_loader.install_dependencies(outside_dir, "evil_plugin", plugins_dir=tmp_plugins_dir)
|
||||||
|
|
||||||
|
assert result is False
|
||||||
|
mock_subprocess.assert_not_called()
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ from unittest.mock import MagicMock, patch
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from src.plugin_system.plugin_manager import PluginManager
|
from src.plugin_system.plugin_manager import PluginManager
|
||||||
from src.plugin_system.plugin_state import PluginState
|
from src.plugin_system.plugin_state import PluginState
|
||||||
|
from src.plugin_system.resource_monitor import PluginResourceMonitor
|
||||||
|
|
||||||
class TestPluginManager:
|
class TestPluginManager:
|
||||||
"""Test PluginManager functionality."""
|
"""Test PluginManager functionality."""
|
||||||
@@ -78,6 +79,54 @@ class TestPluginManager:
|
|||||||
assert result is False
|
assert result is False
|
||||||
assert pm.state_manager.get_state("non_existent_plugin") == PluginState.ERROR
|
assert pm.state_manager.get_state("non_existent_plugin") == PluginState.ERROR
|
||||||
|
|
||||||
|
def test_run_scheduled_updates_calls_update_with_resource_monitor(
|
||||||
|
self, mock_config_manager, mock_display_manager, mock_cache_manager
|
||||||
|
):
|
||||||
|
"""Regression test: run_scheduled_updates() must actually call a
|
||||||
|
plugin's update() when self.resource_monitor is set (as it is in
|
||||||
|
every real deployment -- display_controller.py and web_interface/
|
||||||
|
app.py both assign a real PluginResourceMonitor after construction).
|
||||||
|
|
||||||
|
Previously, the resource_monitor branch wrapped the call in a
|
||||||
|
function stored as a *class* attribute on a dynamically-built type
|
||||||
|
(`type('obj', (object,), {'update': monitored_update})()`), which
|
||||||
|
the descriptor protocol turns into a bound method on access --
|
||||||
|
silently passing the synthetic instance as an implicit first
|
||||||
|
argument to monitored_update(), which takes none. Every plugin's
|
||||||
|
scheduled update failed with "monitored_update() takes 0 positional
|
||||||
|
arguments but 1 was given" and was silently swallowed into a
|
||||||
|
circuit-breaker retry loop that never succeeded, so plugin data
|
||||||
|
(scores, odds, etc.) never refreshed.
|
||||||
|
"""
|
||||||
|
with patch('src.plugin_system.plugin_manager.ensure_directory_permissions'):
|
||||||
|
pm = PluginManager(
|
||||||
|
plugins_dir="plugins",
|
||||||
|
config_manager=mock_config_manager,
|
||||||
|
display_manager=mock_display_manager,
|
||||||
|
cache_manager=mock_cache_manager
|
||||||
|
)
|
||||||
|
|
||||||
|
plugin_instance = MagicMock()
|
||||||
|
plugin_instance.enabled = True
|
||||||
|
plugin_instance.update = MagicMock()
|
||||||
|
|
||||||
|
pm.plugins["test_plugin"] = plugin_instance
|
||||||
|
pm.plugin_manifests["test_plugin"] = {"update_interval": 10}
|
||||||
|
pm.state_manager.set_state("test_plugin", PluginState.ENABLED)
|
||||||
|
# Plain MagicMock, not the mock_cache_manager fixture: this test
|
||||||
|
# is about run_scheduled_updates() actually invoking update()
|
||||||
|
# through the resource-monitor wrapper, not about
|
||||||
|
# PluginResourceMonitor's own cache-backed metrics persistence
|
||||||
|
# (which calls cache_manager.get(..., memory_ttl=...) --
|
||||||
|
# a kwarg the fixture's mock_get() doesn't accept).
|
||||||
|
pm.resource_monitor = PluginResourceMonitor(MagicMock())
|
||||||
|
|
||||||
|
pm.run_scheduled_updates(current_time=time.time())
|
||||||
|
|
||||||
|
plugin_instance.update.assert_called_once()
|
||||||
|
assert "test_plugin" in pm.plugin_last_update
|
||||||
|
assert pm.state_manager.get_state("test_plugin") == PluginState.ENABLED
|
||||||
|
|
||||||
|
|
||||||
class TestPluginLoader:
|
class TestPluginLoader:
|
||||||
"""Test PluginLoader functionality."""
|
"""Test PluginLoader functionality."""
|
||||||
|
|||||||
Reference in New Issue
Block a user