mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-01 16:58:06 +00:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
63d1e6a365 |
-29
@@ -1,29 +0,0 @@
|
|||||||
# bandit.yaml — LEDMatrix bandit configuration
|
|
||||||
# https://bandit.readthedocs.io/en/latest/config.html
|
|
||||||
#
|
|
||||||
# Skips are justified by the specific codebase context documented below.
|
|
||||||
# Do not remove skips without updating the justification comment.
|
|
||||||
|
|
||||||
skips:
|
|
||||||
# B104: Binding to all interfaces (0.0.0.0)
|
|
||||||
# Intentional — the Flask server binds 0.0.0.0 for LAN access on a Raspberry Pi.
|
|
||||||
# This is not internet-facing and is documented in web_interface/app.py.
|
|
||||||
- B104
|
|
||||||
|
|
||||||
# B603: subprocess call without shell=True
|
|
||||||
# All subprocess.run() calls in this codebase use list arguments (confirmed by
|
|
||||||
# grep — zero uses of shell=True in src/ or web_interface/). List args prevent
|
|
||||||
# shell injection. See src/common/permission_utils.py for the primary usage.
|
|
||||||
- B603
|
|
||||||
|
|
||||||
# B607: Starting a process with a partial executable path
|
|
||||||
# The subprocess calls invoke system utilities (systemctl, sudo, git) by name.
|
|
||||||
# These are fixed-list invocations, not user-controlled, and rely on PATH.
|
|
||||||
- B607
|
|
||||||
|
|
||||||
exclude_dirs:
|
|
||||||
- tests
|
|
||||||
- test
|
|
||||||
- venv
|
|
||||||
- .venv
|
|
||||||
- rpi-rgb-led-matrix-master
|
|
||||||
@@ -248,6 +248,7 @@ test/
|
|||||||
├── test_config_service.py # Config service tests
|
├── test_config_service.py # Config service tests
|
||||||
├── test_config_validation_edge_cases.py # Config edge cases
|
├── test_config_validation_edge_cases.py # Config edge cases
|
||||||
├── test_font_manager.py # Font manager tests
|
├── test_font_manager.py # Font manager tests
|
||||||
|
├── test_layout_manager.py # Layout manager tests
|
||||||
├── test_text_helper.py # Text helper tests
|
├── test_text_helper.py # Text helper tests
|
||||||
├── test_error_handling.py # Error handling tests
|
├── test_error_handling.py # Error handling tests
|
||||||
├── test_error_aggregator.py # Error aggregation tests
|
├── test_error_aggregator.py # Error aggregation tests
|
||||||
|
|||||||
@@ -8,11 +8,16 @@ numpy>=1.24.0 # For fast array operations in ScrollHelper (compatible with 2.x)
|
|||||||
|
|
||||||
# Timezone handling
|
# Timezone handling
|
||||||
pytz>=2024.2,<2025.0 # Updated for latest timezone data
|
pytz>=2024.2,<2025.0 # Updated for latest timezone data
|
||||||
|
timezonefinder>=6.5.0,<7.0.0 # Updated for better performance and accuracy
|
||||||
|
geopy>=2.4.1,<3.0.0
|
||||||
|
|
||||||
# HTTP requests
|
# HTTP requests
|
||||||
requests>=2.33.0,<3.0.0
|
requests>=2.33.0,<3.0.0
|
||||||
|
|
||||||
# Google API integration
|
# Google API integration
|
||||||
|
google-auth-oauthlib>=1.2.0,<2.0.0
|
||||||
|
google-auth-httplib2>=0.2.0,<1.0.0
|
||||||
|
google-api-python-client>=2.147.0,<3.0.0
|
||||||
|
|
||||||
# Font rendering
|
# Font rendering
|
||||||
freetype-py>=2.5.1,<3.0.0
|
freetype-py>=2.5.1,<3.0.0
|
||||||
@@ -24,8 +29,10 @@ spotipy>=2.25.2,<3.0.0
|
|||||||
Flask>=3.1.3,<4.0.0
|
Flask>=3.1.3,<4.0.0
|
||||||
|
|
||||||
# Text processing
|
# Text processing
|
||||||
|
unidecode>=1.3.8,<2.0.0
|
||||||
|
|
||||||
# Calendar integration
|
# Calendar integration
|
||||||
|
icalevents>=0.1.27,<1.0.0
|
||||||
|
|
||||||
# WebSocket support
|
# WebSocket support
|
||||||
python-socketio>=5.14.0,<6.0.0
|
python-socketio>=5.14.0,<6.0.0
|
||||||
|
|||||||
@@ -1,344 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""
|
|
||||||
LEDMatrix Plugin Security Auditor
|
|
||||||
|
|
||||||
Performs AST-based security analysis of all Python files in plugin directories.
|
|
||||||
Designed to run in CI — exits non-zero on CRITICAL findings only.
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
python scripts/audit_plugins.py
|
|
||||||
python scripts/audit_plugins.py --verbose
|
|
||||||
python scripts/audit_plugins.py --plugin hello-world
|
|
||||||
python scripts/audit_plugins.py --output results.json
|
|
||||||
"""
|
|
||||||
|
|
||||||
import ast
|
|
||||||
import argparse
|
|
||||||
import json
|
|
||||||
import sys
|
|
||||||
from dataclasses import dataclass, asdict
|
|
||||||
from pathlib import Path
|
|
||||||
from datetime import datetime, timezone
|
|
||||||
|
|
||||||
PROJECT_ROOT = Path(__file__).resolve().parent.parent
|
|
||||||
|
|
||||||
PLUGIN_BASE_DIRS = [
|
|
||||||
PROJECT_ROOT / "plugins",
|
|
||||||
PROJECT_ROOT / "plugin-repos",
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# Finding dataclass
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class Finding:
|
|
||||||
plugin_id: str
|
|
||||||
file: str
|
|
||||||
line: int
|
|
||||||
severity: str # CRITICAL | WARNING | INFO
|
|
||||||
rule: str
|
|
||||||
message: str
|
|
||||||
|
|
||||||
def to_dict(self) -> dict:
|
|
||||||
return asdict(self)
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# AST visitor
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
class _PluginVisitor(ast.NodeVisitor):
|
|
||||||
"""Collect security findings from a single plugin Python file."""
|
|
||||||
|
|
||||||
def __init__(self, filepath: Path, plugin_id: str):
|
|
||||||
self.filepath = filepath
|
|
||||||
self.plugin_id = plugin_id
|
|
||||||
self.findings: list[Finding] = []
|
|
||||||
# Local name -> real dotted path, so aliased imports and from-imports
|
|
||||||
# of dangerous APIs (import subprocess as sp; from builtins import
|
|
||||||
# eval as e) are still recognized in visit_Call below.
|
|
||||||
self._aliases: dict[str, str] = {}
|
|
||||||
|
|
||||||
def _add(self, node: ast.AST, severity: str, rule: str, message: str) -> None:
|
|
||||||
self.findings.append(Finding(
|
|
||||||
plugin_id=self.plugin_id,
|
|
||||||
file=str(self.filepath.relative_to(PROJECT_ROOT)),
|
|
||||||
line=getattr(node, "lineno", 0),
|
|
||||||
severity=severity,
|
|
||||||
rule=rule,
|
|
||||||
message=message,
|
|
||||||
))
|
|
||||||
|
|
||||||
def _resolve(self, local_name: str) -> str:
|
|
||||||
"""Resolve a local name through recorded import aliases to its real
|
|
||||||
dotted path (e.g. "sp" -> "subprocess"); unresolved names pass through
|
|
||||||
unchanged."""
|
|
||||||
return self._aliases.get(local_name, local_name)
|
|
||||||
|
|
||||||
def _resolve_call_target(self, func: ast.expr) -> str | None:
|
|
||||||
"""Resolve a Call's func node to a fully-qualified dotted target,
|
|
||||||
covering a direct name (bare builtin, aliased import, or
|
|
||||||
from-import: from builtins import eval as e; from subprocess
|
|
||||||
import run; from os import system as s) and module-attribute
|
|
||||||
access (subprocess.run, sp.run, os.system, o.system) uniformly.
|
|
||||||
Returns None for call shapes this doesn't attempt to resolve."""
|
|
||||||
if isinstance(func, ast.Name):
|
|
||||||
return self._resolve(func.id)
|
|
||||||
if isinstance(func, ast.Attribute) and isinstance(func.value, ast.Name):
|
|
||||||
base = self._resolve(func.value.id)
|
|
||||||
return f"{base}.{func.attr}"
|
|
||||||
return None
|
|
||||||
|
|
||||||
def visit_Call(self, node: ast.Call) -> None:
|
|
||||||
target = self._resolve_call_target(node.func)
|
|
||||||
if target is None:
|
|
||||||
self.generic_visit(node)
|
|
||||||
return
|
|
||||||
|
|
||||||
leaf = target.rsplit(".", 1)[-1]
|
|
||||||
|
|
||||||
# eval() / exec() / compile() — arbitrary code execution, whether a
|
|
||||||
# bare call, an aliased import, or a from-import
|
|
||||||
# (from builtins import eval as e; e(...))
|
|
||||||
if leaf == "eval":
|
|
||||||
self._add(node, "CRITICAL", "PLUGIN-001",
|
|
||||||
"eval() call — arbitrary code execution risk")
|
|
||||||
elif leaf == "exec":
|
|
||||||
self._add(node, "CRITICAL", "PLUGIN-002",
|
|
||||||
"exec() call — arbitrary code execution risk")
|
|
||||||
elif leaf == "compile":
|
|
||||||
self._add(node, "WARNING", "PLUGIN-003",
|
|
||||||
"compile() call — dynamic code compilation")
|
|
||||||
|
|
||||||
# subprocess.*(shell=True), whether subprocess.run(...), sp.run(...),
|
|
||||||
# or a from-import (from subprocess import run; run(..., shell=True))
|
|
||||||
if target in {
|
|
||||||
"subprocess.run", "subprocess.call", "subprocess.Popen",
|
|
||||||
"subprocess.check_call", "subprocess.check_output",
|
|
||||||
}:
|
|
||||||
for kw in node.keywords:
|
|
||||||
if (kw.arg == "shell" and
|
|
||||||
isinstance(kw.value, ast.Constant) and
|
|
||||||
kw.value.value is True):
|
|
||||||
self._add(node, "WARNING", "PLUGIN-004",
|
|
||||||
f"subprocess.{leaf}(shell=True) — "
|
|
||||||
f"shell injection risk if args include user input")
|
|
||||||
|
|
||||||
# os.system(), whether os.system(...), o.system(...), or a
|
|
||||||
# from-import (from os import system as s; s(...))
|
|
||||||
if target == "os.system":
|
|
||||||
self._add(node, "WARNING", "PLUGIN-005",
|
|
||||||
"os.system() call — prefer subprocess with list args")
|
|
||||||
|
|
||||||
self.generic_visit(node)
|
|
||||||
|
|
||||||
def visit_Import(self, node: ast.Import) -> None:
|
|
||||||
for alias in node.names:
|
|
||||||
if alias.asname:
|
|
||||||
local, real = alias.asname, alias.name
|
|
||||||
else:
|
|
||||||
# `import os.path` binds the top-level name `os`, not `os.path`
|
|
||||||
local = real = alias.name.split(".")[0]
|
|
||||||
self._aliases[local] = real
|
|
||||||
self._check_import(node, alias.name)
|
|
||||||
self.generic_visit(node)
|
|
||||||
|
|
||||||
def visit_ImportFrom(self, node: ast.ImportFrom) -> None:
|
|
||||||
if node.module:
|
|
||||||
for alias in node.names:
|
|
||||||
local = alias.asname or alias.name
|
|
||||||
self._aliases[local] = f"{node.module}.{alias.name}"
|
|
||||||
self._check_import(node, node.module)
|
|
||||||
self.generic_visit(node)
|
|
||||||
|
|
||||||
def _check_import(self, node: ast.AST, module_name: str) -> None:
|
|
||||||
dangerous = {
|
|
||||||
"ctypes": ("WARNING", "PLUGIN-010", "ctypes import — native code execution"),
|
|
||||||
"cffi": ("WARNING", "PLUGIN-011", "cffi import — native code execution"),
|
|
||||||
"pickle": ("WARNING", "PLUGIN-012",
|
|
||||||
"pickle import — deserialization can execute arbitrary code"),
|
|
||||||
"marshal": ("WARNING", "PLUGIN-013",
|
|
||||||
"marshal import — deserialization risk"),
|
|
||||||
}
|
|
||||||
for mod, (severity, rule, msg) in dangerous.items():
|
|
||||||
if module_name == mod or module_name.startswith(mod + "."):
|
|
||||||
self._add(node, severity, rule, msg)
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# Per-plugin audit
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def audit_plugin(plugin_dir: Path) -> list[Finding]:
|
|
||||||
"""Audit a single plugin directory. Returns all findings."""
|
|
||||||
findings: list[Finding] = []
|
|
||||||
plugin_id = plugin_dir.name
|
|
||||||
|
|
||||||
# Check for required files
|
|
||||||
for required_file, rule, msg in [
|
|
||||||
("manifest.json", "PLUGIN-020",
|
|
||||||
"manifest.json missing — plugin may be incomplete"),
|
|
||||||
("config_schema.json", "PLUGIN-021",
|
|
||||||
"config_schema.json missing — no input validation schema declared"),
|
|
||||||
]:
|
|
||||||
if not (plugin_dir / required_file).exists():
|
|
||||||
findings.append(Finding(
|
|
||||||
plugin_id=plugin_id,
|
|
||||||
file=str((plugin_dir / required_file).relative_to(PROJECT_ROOT)),
|
|
||||||
line=0,
|
|
||||||
severity="WARNING",
|
|
||||||
rule=rule,
|
|
||||||
message=msg,
|
|
||||||
))
|
|
||||||
|
|
||||||
# AST analysis of all Python files
|
|
||||||
for py_file in sorted(plugin_dir.rglob("*.py")):
|
|
||||||
try:
|
|
||||||
source = py_file.read_text(encoding="utf-8")
|
|
||||||
tree = ast.parse(source, filename=str(py_file))
|
|
||||||
visitor = _PluginVisitor(py_file, plugin_id)
|
|
||||||
visitor.visit(tree)
|
|
||||||
findings.extend(visitor.findings)
|
|
||||||
except SyntaxError as exc:
|
|
||||||
# A file the visitor can't even parse is a file we can't verify
|
|
||||||
# is safe -- this must block the audit, not just warn.
|
|
||||||
findings.append(Finding(
|
|
||||||
plugin_id=plugin_id,
|
|
||||||
file=str(py_file.relative_to(PROJECT_ROOT)),
|
|
||||||
line=getattr(exc, "lineno", 0) or 0,
|
|
||||||
severity="CRITICAL",
|
|
||||||
rule="PLUGIN-030",
|
|
||||||
message=f"Python syntax error — cannot be parsed: {exc}",
|
|
||||||
))
|
|
||||||
except OSError as exc:
|
|
||||||
# Same reasoning as SyntaxError: an unreadable file was never
|
|
||||||
# actually scanned, so it must block rather than pass silently.
|
|
||||||
findings.append(Finding(
|
|
||||||
plugin_id=plugin_id,
|
|
||||||
file=str(py_file.relative_to(PROJECT_ROOT)),
|
|
||||||
line=0,
|
|
||||||
severity="CRITICAL",
|
|
||||||
rule="PLUGIN-031",
|
|
||||||
message=f"Could not read file: {exc}",
|
|
||||||
))
|
|
||||||
|
|
||||||
return findings
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# Main
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def main() -> int:
|
|
||||||
parser = argparse.ArgumentParser(
|
|
||||||
description="LEDMatrix plugin security auditor",
|
|
||||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
||||||
)
|
|
||||||
parser.add_argument("--plugin", "-p", default=None,
|
|
||||||
help="Audit a specific plugin ID only")
|
|
||||||
parser.add_argument("--output", "-o", default=None,
|
|
||||||
help="Write JSON results to this file")
|
|
||||||
parser.add_argument("--verbose", "-v", action="store_true",
|
|
||||||
help="Show all findings, not just summary")
|
|
||||||
args = parser.parse_args()
|
|
||||||
|
|
||||||
print("=" * 60)
|
|
||||||
print("LEDMatrix Plugin Security Audit")
|
|
||||||
print(f"Project root: {PROJECT_ROOT}")
|
|
||||||
print("=" * 60)
|
|
||||||
|
|
||||||
all_findings: list[Finding] = []
|
|
||||||
plugins_scanned = 0
|
|
||||||
plugin_found = args.plugin is None
|
|
||||||
|
|
||||||
for base_dir in PLUGIN_BASE_DIRS:
|
|
||||||
if not base_dir.exists():
|
|
||||||
if args.verbose:
|
|
||||||
print(f" ⏭️ Skipping {base_dir.name}/ (directory not found)")
|
|
||||||
continue
|
|
||||||
|
|
||||||
base_label = base_dir.relative_to(PROJECT_ROOT)
|
|
||||||
print(f"\n Scanning {base_label}/")
|
|
||||||
|
|
||||||
for plugin_dir in sorted(base_dir.iterdir()):
|
|
||||||
if not plugin_dir.is_dir():
|
|
||||||
continue
|
|
||||||
if plugin_dir.name.startswith((".", "_")):
|
|
||||||
continue
|
|
||||||
if args.plugin and plugin_dir.name != args.plugin:
|
|
||||||
continue
|
|
||||||
if args.plugin:
|
|
||||||
plugin_found = True
|
|
||||||
|
|
||||||
findings = audit_plugin(plugin_dir)
|
|
||||||
all_findings.extend(findings)
|
|
||||||
plugins_scanned += 1
|
|
||||||
|
|
||||||
critical = [f for f in findings if f.severity == "CRITICAL"]
|
|
||||||
warnings = [f for f in findings if f.severity == "WARNING"]
|
|
||||||
|
|
||||||
if critical:
|
|
||||||
icon, label = "🚨", "CRITICAL"
|
|
||||||
elif warnings:
|
|
||||||
icon, label = "⚠️ ", "WARN "
|
|
||||||
else:
|
|
||||||
icon, label = "✅", "PASS "
|
|
||||||
|
|
||||||
print(f" {icon} [{label}] {plugin_dir.name}"
|
|
||||||
f" — {len(critical)} critical, {len(warnings)} warnings")
|
|
||||||
|
|
||||||
if args.verbose:
|
|
||||||
for f in findings:
|
|
||||||
severity_icon = {"CRITICAL": "🚨", "WARNING": "⚠️ ", "INFO": "ℹ️ "}.get(
|
|
||||||
f.severity, " "
|
|
||||||
)
|
|
||||||
print(f" {severity_icon} {f.rule} {f.file}:{f.line} — {f.message}")
|
|
||||||
|
|
||||||
if args.plugin and not plugin_found:
|
|
||||||
print(f"\n 🚨 Plugin '{args.plugin}' not found in any of "
|
|
||||||
f"{[str(d.relative_to(PROJECT_ROOT)) for d in PLUGIN_BASE_DIRS]} — "
|
|
||||||
f"nothing was audited")
|
|
||||||
return 1
|
|
||||||
|
|
||||||
# Summary
|
|
||||||
critical_findings = [f for f in all_findings if f.severity == "CRITICAL"]
|
|
||||||
warning_findings = [f for f in all_findings if f.severity == "WARNING"]
|
|
||||||
|
|
||||||
print(f"\n{'=' * 60}")
|
|
||||||
print(f" Plugins scanned : {plugins_scanned}")
|
|
||||||
print(f" CRITICAL : {len(critical_findings)}")
|
|
||||||
print(f" WARNING : {len(warning_findings)}")
|
|
||||||
|
|
||||||
if critical_findings:
|
|
||||||
print("\n 🚨 CRITICAL findings:")
|
|
||||||
for f in critical_findings:
|
|
||||||
print(f" {f.plugin_id} | {Path(f.file).name}:{f.line} | {f.message}")
|
|
||||||
|
|
||||||
# Write JSON output
|
|
||||||
if args.output:
|
|
||||||
output_data = {
|
|
||||||
"timestamp": datetime.now(timezone.utc).isoformat(),
|
|
||||||
"plugins_scanned": plugins_scanned,
|
|
||||||
"summary": {
|
|
||||||
"critical": len(critical_findings),
|
|
||||||
"warnings": len(warning_findings),
|
|
||||||
},
|
|
||||||
"findings": [f.to_dict() for f in all_findings],
|
|
||||||
}
|
|
||||||
Path(args.output).write_text(
|
|
||||||
json.dumps(output_data, indent=2), encoding="utf-8"
|
|
||||||
)
|
|
||||||
print(f"\n Results written to: {args.output}")
|
|
||||||
|
|
||||||
if critical_findings:
|
|
||||||
print("\n 🚨 Blocking — CRITICAL issues must be resolved")
|
|
||||||
return 1
|
|
||||||
|
|
||||||
print("\n ✅ No critical issues found")
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
sys.exit(main())
|
|
||||||
@@ -55,7 +55,7 @@ def main():
|
|||||||
failures += not check("draw.textbbox",
|
failures += not check("draw.textbbox",
|
||||||
lambda: draw.textbbox((0, 0), "Test", font=font))
|
lambda: draw.textbbox((0, 0), "Test", font=font))
|
||||||
|
|
||||||
print("\nResampling (used in logo_helper, sports base):")
|
print("\nResampling (used in logo_helper, image_utils, sports base):")
|
||||||
logo = Image.new('RGBA', (200, 200), (255, 128, 0, 200))
|
logo = Image.new('RGBA', (200, 200), (255, 128, 0, 200))
|
||||||
failures += not check("Image.Resampling.LANCZOS exists",
|
failures += not check("Image.Resampling.LANCZOS exists",
|
||||||
lambda: str(Image.Resampling.LANCZOS))
|
lambda: str(Image.Resampling.LANCZOS))
|
||||||
|
|||||||
@@ -1,356 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""
|
|
||||||
Security Report Generator
|
|
||||||
|
|
||||||
Aggregates JSON output from all CI security audit jobs into a single
|
|
||||||
Markdown report suitable for PR comments and artifact storage.
|
|
||||||
|
|
||||||
Expected artifact layout (from actions/download-artifact@v4):
|
|
||||||
<artifact-dir>/
|
|
||||||
sast-results/
|
|
||||||
bandit-results.json
|
|
||||||
semgrep-results.json
|
|
||||||
dependency-audit-results/
|
|
||||||
pip-audit-results.json
|
|
||||||
safety-results.json
|
|
||||||
secrets-scan-results/
|
|
||||||
gitleaks-results.json
|
|
||||||
security-proofs-results/
|
|
||||||
security-proofs-results.json
|
|
||||||
plugin-audit-results/
|
|
||||||
plugin-audit-results.json
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
python scripts/generate_report.py --artifact-dir audit-artifacts/ --output report.md
|
|
||||||
python scripts/generate_report.py --artifact-dir audit-artifacts/ --output report.md --verbose
|
|
||||||
"""
|
|
||||||
|
|
||||||
import argparse
|
|
||||||
import json
|
|
||||||
import sys
|
|
||||||
from pathlib import Path
|
|
||||||
from datetime import datetime, timezone
|
|
||||||
|
|
||||||
PROJECT_ROOT = Path(__file__).resolve().parent.parent
|
|
||||||
|
|
||||||
# Gitleaks matches exactly equal to one of these (not a substring match -- a
|
|
||||||
# real secret that merely contains one of these words as part of its actual
|
|
||||||
# value must still be reported) are known template placeholders.
|
|
||||||
_GITLEAKS_SUPPRESS_EXACT_VALUES = {
|
|
||||||
"YOUR_YOUTUBE_API_KEY",
|
|
||||||
"YOUR_YOUTUBE_CHANNEL_ID",
|
|
||||||
"YOUR_GITHUB_PERSONAL_ACCESS_TOKEN",
|
|
||||||
}
|
|
||||||
|
|
||||||
# Findings in these files are suppressed regardless of value -- they are
|
|
||||||
# template/example files that are expected to only ever contain placeholders.
|
|
||||||
_GITLEAKS_SUPPRESS_PATHS = [
|
|
||||||
"config_secrets.template.json",
|
|
||||||
"config.template.json",
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# Helpers
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def _load(path: Path) -> tuple[dict | list | None, str | None]:
|
|
||||||
"""Load a JSON artifact file.
|
|
||||||
|
|
||||||
Returns (data, error): error is None on success (data is whatever was
|
|
||||||
parsed, which may legitimately be an empty list/dict for a clean scan);
|
|
||||||
otherwise error is a human-readable reason the artifact is unavailable,
|
|
||||||
distinguishing "missing/malformed artifact" from "valid empty result" so
|
|
||||||
callers don't silently treat a broken CI job as a clean pass.
|
|
||||||
"""
|
|
||||||
if not path.exists():
|
|
||||||
return None, f"artifact not found: {path}"
|
|
||||||
try:
|
|
||||||
return json.loads(path.read_text(encoding="utf-8")), None
|
|
||||||
except (json.JSONDecodeError, OSError) as exc:
|
|
||||||
return None, f"could not read/parse {path}: {exc}"
|
|
||||||
|
|
||||||
|
|
||||||
def _md_sanitize_cell(value: object) -> str:
|
|
||||||
"""Escape/normalize a value so scanner-controlled content (a matched
|
|
||||||
secret, a bandit issue_text, a file path) can't alter the Markdown
|
|
||||||
table's structure: pipes would add bogus columns, newlines would break
|
|
||||||
out of the row (or forge a fake header/separator line)."""
|
|
||||||
text = str(value)
|
|
||||||
text = text.replace("\\", "\\\\").replace("|", "\\|")
|
|
||||||
text = text.replace("\r\n", " ").replace("\n", " ").replace("\r", " ")
|
|
||||||
return text
|
|
||||||
|
|
||||||
|
|
||||||
def _md_table_row(*cells: str) -> str:
|
|
||||||
return "| " + " | ".join(_md_sanitize_cell(c) for c in cells) + " |"
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# Per-tool summarizers
|
|
||||||
# Returns: (markdown_lines: list[str], critical_count: int, available: bool)
|
|
||||||
# `available=False` means the artifact was missing or malformed -- distinct
|
|
||||||
# from a valid scan that simply found nothing -- so the caller can report
|
|
||||||
# INCOMPLETE instead of silently counting it as a clean pass.
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def _summarize_bandit(artifact_dir: Path) -> tuple[list[str], int, bool]:
|
|
||||||
data, error = _load(artifact_dir / "sast-results" / "bandit-results.json")
|
|
||||||
if error:
|
|
||||||
return [f"_bandit results unavailable: {error}_"], 0, False
|
|
||||||
|
|
||||||
results = data.get("results", [])
|
|
||||||
high = [r for r in results if r.get("issue_severity") == "HIGH"]
|
|
||||||
medium = [r for r in results if r.get("issue_severity") == "MEDIUM"]
|
|
||||||
low = [r for r in results if r.get("issue_severity") == "LOW"]
|
|
||||||
|
|
||||||
lines = [
|
|
||||||
f"**Bandit**: {len(high)} HIGH · {len(medium)} MEDIUM · {len(low)} LOW"
|
|
||||||
]
|
|
||||||
|
|
||||||
if high:
|
|
||||||
lines += [
|
|
||||||
"",
|
|
||||||
"| Severity | File | Line | Issue |",
|
|
||||||
"| --- | --- | --- | --- |",
|
|
||||||
]
|
|
||||||
for r in high[:10]:
|
|
||||||
fname = Path(r.get("filename", "")).name
|
|
||||||
lines.append(_md_table_row(
|
|
||||||
"HIGH", f"`{fname}`",
|
|
||||||
str(r.get("line_number", "?")),
|
|
||||||
r.get("issue_text", "")
|
|
||||||
))
|
|
||||||
if len(high) > 10:
|
|
||||||
lines.append(f"_… and {len(high) - 10} more HIGH findings_")
|
|
||||||
|
|
||||||
return lines, len(high), True
|
|
||||||
|
|
||||||
|
|
||||||
def _summarize_pip_audit(artifact_dir: Path) -> tuple[list[str], int, bool]:
|
|
||||||
data, error = _load(artifact_dir / "dependency-audit-results" / "pip-audit-results.json")
|
|
||||||
if error:
|
|
||||||
return [f"_pip-audit results unavailable: {error}_"], 0, False
|
|
||||||
|
|
||||||
# pip-audit JSON format: {"dependencies": [{"name": ..., "vulns": [...]}]}
|
|
||||||
vulns: list[dict] = []
|
|
||||||
for dep in data.get("dependencies", []):
|
|
||||||
for v in dep.get("vulns", []):
|
|
||||||
vulns.append({"package": dep.get("name", "?"), **v})
|
|
||||||
|
|
||||||
lines = [f"**pip-audit**: {len(vulns)} vulnerabilities found"]
|
|
||||||
|
|
||||||
if vulns:
|
|
||||||
lines += ["", "| Package | ID | Fix |", "| --- | --- | --- |"]
|
|
||||||
for v in vulns[:10]:
|
|
||||||
fix = v.get("fix_versions", ["none"])
|
|
||||||
fix_str = ", ".join(fix) if fix else "none"
|
|
||||||
lines.append(_md_table_row(
|
|
||||||
v.get("package", "?"),
|
|
||||||
v.get("id", "?"),
|
|
||||||
fix_str,
|
|
||||||
))
|
|
||||||
|
|
||||||
# Treat known vulnerabilities as warnings, not critical (they may be unavoidable)
|
|
||||||
return lines, 0, True
|
|
||||||
|
|
||||||
|
|
||||||
def _summarize_gitleaks(artifact_dir: Path) -> tuple[list[str], int, bool]:
|
|
||||||
data, error = _load(artifact_dir / "secrets-scan-results" / "gitleaks-results.json")
|
|
||||||
if error:
|
|
||||||
return [f"_gitleaks results unavailable: {error}_"], 0, False
|
|
||||||
|
|
||||||
if not isinstance(data, list):
|
|
||||||
data = []
|
|
||||||
|
|
||||||
real_findings = []
|
|
||||||
suppressed = 0
|
|
||||||
for finding in data:
|
|
||||||
secret_val = str(finding.get("Secret", "") or finding.get("Match", ""))
|
|
||||||
file_name = Path(finding.get("File", "")).name
|
|
||||||
if (secret_val in _GITLEAKS_SUPPRESS_EXACT_VALUES
|
|
||||||
or file_name in _GITLEAKS_SUPPRESS_PATHS):
|
|
||||||
suppressed += 1
|
|
||||||
else:
|
|
||||||
real_findings.append(finding)
|
|
||||||
|
|
||||||
lines = [
|
|
||||||
f"**Gitleaks**: {len(real_findings)} finding(s) "
|
|
||||||
f"({suppressed} suppressed as template placeholders)"
|
|
||||||
]
|
|
||||||
|
|
||||||
if real_findings:
|
|
||||||
lines += ["", "| Rule | File | Line | Description |", "| --- | --- | --- | --- |"]
|
|
||||||
for f in real_findings[:10]:
|
|
||||||
fname = Path(f.get("File", "")).name
|
|
||||||
lines.append(_md_table_row(
|
|
||||||
f.get("RuleID", "?"),
|
|
||||||
f"`{fname}`",
|
|
||||||
str(f.get("StartLine", "?")),
|
|
||||||
f.get("Description", ""),
|
|
||||||
))
|
|
||||||
|
|
||||||
critical = len(real_findings) # any real secret is critical
|
|
||||||
return lines, critical, True
|
|
||||||
|
|
||||||
|
|
||||||
def _summarize_security_proofs(artifact_dir: Path) -> tuple[list[str], int, bool]:
|
|
||||||
data, error = _load(artifact_dir / "security-proofs-results" / "security-proofs-results.json")
|
|
||||||
if error:
|
|
||||||
return [f"_security proofs results unavailable: {error}_"], 0, False
|
|
||||||
|
|
||||||
if not isinstance(data, list):
|
|
||||||
data = []
|
|
||||||
|
|
||||||
critical = [r for r in data if r.get("severity") == "CRITICAL"]
|
|
||||||
warnings = [r for r in data if r.get("severity") == "WARNING"]
|
|
||||||
passed = [r for r in data if r.get("severity") == "PASS"]
|
|
||||||
skipped = [r for r in data if r.get("severity") == "SKIP"]
|
|
||||||
|
|
||||||
lines = [
|
|
||||||
f"**Security Proofs**: "
|
|
||||||
f"{len(passed)} PASS · {len(warnings)} WARN · "
|
|
||||||
f"{len(critical)} CRITICAL · {len(skipped)} SKIP",
|
|
||||||
"",
|
|
||||||
]
|
|
||||||
|
|
||||||
_icon = {"PASS": "✅", "INFO": "ℹ️", "WARNING": "⚠️", # nosec B105 - severity labels, not credentials
|
|
||||||
"CRITICAL": "🚨", "SKIP": "⏭️"}
|
|
||||||
for r in data:
|
|
||||||
icon = _icon.get(r.get("severity", ""), "❓")
|
|
||||||
lines.append(
|
|
||||||
f"- {icon} **{r.get('test_id', '?')}**: {r.get('message', '')}"
|
|
||||||
)
|
|
||||||
if r.get("details") and r.get("severity") in ("CRITICAL", "WARNING"):
|
|
||||||
lines.append(f" - _{r['details']}_")
|
|
||||||
|
|
||||||
return lines, len(critical), True
|
|
||||||
|
|
||||||
|
|
||||||
def _summarize_plugin_audit(artifact_dir: Path) -> tuple[list[str], int, bool]:
|
|
||||||
data, error = _load(artifact_dir / "plugin-audit-results" / "plugin-audit-results.json")
|
|
||||||
if error:
|
|
||||||
return [f"_plugin audit results unavailable: {error}_"], 0, False
|
|
||||||
|
|
||||||
summary = data.get("summary", {})
|
|
||||||
findings = data.get("findings", [])
|
|
||||||
critical_findings = [f for f in findings if f.get("severity") == "CRITICAL"]
|
|
||||||
warning_findings = [f for f in findings if f.get("severity") == "WARNING"]
|
|
||||||
|
|
||||||
lines = [
|
|
||||||
f"**Plugin Audit**: {data.get('plugins_scanned', '?')} plugins scanned — "
|
|
||||||
f"{summary.get('critical', 0)} CRITICAL · {summary.get('warnings', 0)} WARNINGS"
|
|
||||||
]
|
|
||||||
|
|
||||||
if critical_findings:
|
|
||||||
lines += ["", "| Plugin | File | Line | Rule | Message |",
|
|
||||||
"| --- | --- | --- | --- | --- |"]
|
|
||||||
for f in critical_findings[:10]:
|
|
||||||
fname = Path(f.get("file", "")).name
|
|
||||||
lines.append(_md_table_row(
|
|
||||||
f.get("plugin_id", "?"),
|
|
||||||
f"`{fname}`",
|
|
||||||
str(f.get("line", "?")),
|
|
||||||
f.get("rule", "?"),
|
|
||||||
f.get("message", ""),
|
|
||||||
))
|
|
||||||
|
|
||||||
if warning_findings and not critical_findings:
|
|
||||||
lines.append(f"\n_{len(warning_findings)} warning(s) found — see artifact for details_")
|
|
||||||
|
|
||||||
return lines, summary.get("critical", 0), True
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# Main
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def main() -> int:
|
|
||||||
parser = argparse.ArgumentParser(
|
|
||||||
description="Generate consolidated security audit report",
|
|
||||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
||||||
)
|
|
||||||
parser.add_argument("--artifact-dir", required=True,
|
|
||||||
help="Directory containing downloaded CI artifacts")
|
|
||||||
parser.add_argument("--output", "-o", required=True,
|
|
||||||
help="Output Markdown file path")
|
|
||||||
parser.add_argument("--verbose", "-v", action="store_true")
|
|
||||||
args = parser.parse_args()
|
|
||||||
|
|
||||||
artifact_dir = Path(args.artifact_dir)
|
|
||||||
timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M UTC")
|
|
||||||
|
|
||||||
bandit_lines, bandit_crit, bandit_ok = _summarize_bandit(artifact_dir)
|
|
||||||
pip_audit_lines, pip_audit_crit, pip_audit_ok = _summarize_pip_audit(artifact_dir)
|
|
||||||
gitleaks_lines, gitleaks_crit, gitleaks_ok = _summarize_gitleaks(artifact_dir)
|
|
||||||
proofs_lines, proofs_crit, proofs_ok = _summarize_security_proofs(artifact_dir)
|
|
||||||
plugins_lines, plugins_crit, plugins_ok = _summarize_plugin_audit(artifact_dir)
|
|
||||||
|
|
||||||
unavailable_tools = [
|
|
||||||
name for name, ok in [
|
|
||||||
("bandit", bandit_ok), ("pip-audit", pip_audit_ok),
|
|
||||||
("gitleaks", gitleaks_ok), ("security-proofs", proofs_ok),
|
|
||||||
("plugin-audit", plugins_ok),
|
|
||||||
] if not ok
|
|
||||||
]
|
|
||||||
|
|
||||||
total_critical = bandit_crit + pip_audit_crit + gitleaks_crit + proofs_crit + plugins_crit
|
|
||||||
if unavailable_tools:
|
|
||||||
# A missing/malformed artifact means that tool's checks never
|
|
||||||
# actually ran -- this must not be reported as a clean PASS just
|
|
||||||
# because the *artifacts that did load* found nothing.
|
|
||||||
overall = "INCOMPLETE ⚠️"
|
|
||||||
elif total_critical > 0:
|
|
||||||
overall = "ACTION REQUIRED 🚨"
|
|
||||||
else:
|
|
||||||
overall = "PASSED ✅"
|
|
||||||
|
|
||||||
def section(title: str, lines: list[str]) -> str:
|
|
||||||
return f"### {title}\n\n" + "\n".join(lines) + "\n"
|
|
||||||
|
|
||||||
incomplete_note = (
|
|
||||||
f"\n_⚠️ Incomplete: results unavailable for {', '.join(unavailable_tools)} "
|
|
||||||
f"— see the corresponding section(s) below for details_\n"
|
|
||||||
if unavailable_tools else ""
|
|
||||||
)
|
|
||||||
|
|
||||||
report = f"""## 🔒 Security Audit — {overall}
|
|
||||||
|
|
||||||
_Generated: {timestamp}_
|
|
||||||
{incomplete_note}
|
|
||||||
| Critical | High/Warn | Overall |
|
|
||||||
| :---: | :---: | :---: |
|
|
||||||
| {'🚨 ' + str(total_critical) if total_critical else '✅ 0'} | ⚠️ see below | {overall} |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
{section('SAST — Bandit', bandit_lines)}
|
|
||||||
{section('Dependencies — pip-audit', pip_audit_lines)}
|
|
||||||
{section('Secrets — Gitleaks', gitleaks_lines)}
|
|
||||||
{section('LEDMatrix Security Proofs', proofs_lines)}
|
|
||||||
{section('Plugin Security Audit', plugins_lines)}
|
|
||||||
---
|
|
||||||
|
|
||||||
_Total critical findings: **{total_critical}**_
|
|
||||||
"""
|
|
||||||
|
|
||||||
output_path = Path(args.output)
|
|
||||||
output_path.write_text(report, encoding="utf-8")
|
|
||||||
|
|
||||||
if args.verbose:
|
|
||||||
print(f" Report written to: {output_path}")
|
|
||||||
print(f" Status: {overall}")
|
|
||||||
print(f" Critical findings: {total_critical}")
|
|
||||||
print(f" bandit={bandit_crit} pip-audit={pip_audit_crit} "
|
|
||||||
f"gitleaks={gitleaks_crit} proofs={proofs_crit} plugins={plugins_crit}")
|
|
||||||
if unavailable_tools:
|
|
||||||
print(f" Unavailable: {', '.join(unavailable_tools)}")
|
|
||||||
|
|
||||||
if unavailable_tools:
|
|
||||||
return 1
|
|
||||||
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
sys.exit(main())
|
|
||||||
@@ -1,593 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""
|
|
||||||
LEDMatrix Security Proof Tests
|
|
||||||
|
|
||||||
Automated proofs that run in CI to verify security properties hold on every
|
|
||||||
commit. Inspired by the Huntarr security review approach of using standard
|
|
||||||
tooling to confirm specific vulnerability classes are absent.
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
python scripts/prove_security.py
|
|
||||||
python scripts/prove_security.py --verbose
|
|
||||||
python scripts/prove_security.py --output results.json
|
|
||||||
|
|
||||||
Exit code: 1 only if CRITICAL findings are detected. Warnings are reported
|
|
||||||
but do not block CI.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import ast
|
|
||||||
import argparse
|
|
||||||
import hashlib
|
|
||||||
import json
|
|
||||||
import re
|
|
||||||
import sys
|
|
||||||
from dataclasses import dataclass, asdict
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
PROJECT_ROOT = Path(__file__).resolve().parent.parent
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# Result dataclass
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class TestResult:
|
|
||||||
test_id: str
|
|
||||||
severity: str # PASS | INFO | WARNING | CRITICAL | SKIP
|
|
||||||
message: str
|
|
||||||
details: str = ""
|
|
||||||
|
|
||||||
def to_dict(self) -> dict:
|
|
||||||
return asdict(self)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def icon(self) -> str:
|
|
||||||
return {
|
|
||||||
"PASS": "✅", # nosec B105 - severity label, not a credential
|
|
||||||
"INFO": "ℹ️ ",
|
|
||||||
"WARNING": "⚠️ ",
|
|
||||||
"CRITICAL": "🚨",
|
|
||||||
"SKIP": "⏭️ ",
|
|
||||||
}.get(self.severity, "❓")
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# T1: Plugin Loading / Zip Slip
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def test_t1a_zip_slip_protection() -> TestResult:
|
|
||||||
"""
|
|
||||||
Verify that zip-slip protection actually guards zip extraction in
|
|
||||||
store_manager.py.
|
|
||||||
|
|
||||||
A whole-file substring check for "is_relative_to"/"Zip-slip detected"
|
|
||||||
would pass even if the guard existed somewhere unrelated, or covered
|
|
||||||
only one of several extract()/extractall() call sites. Instead, this
|
|
||||||
walks the AST: for every extract()/extractall() call, it confirms an
|
|
||||||
is_relative_to() check (and the "Zip-slip detected" log) appears
|
|
||||||
earlier in that same enclosing function -- validate-then-bulk-extract
|
|
||||||
(validate every member, then call extractall() only after all passed)
|
|
||||||
counts as protecting the call, since it covers the same member list.
|
|
||||||
"""
|
|
||||||
store_manager = PROJECT_ROOT / "src" / "plugin_system" / "store_manager.py"
|
|
||||||
if not store_manager.exists():
|
|
||||||
return TestResult("T1a", "CRITICAL",
|
|
||||||
"store_manager.py not found",
|
|
||||||
f"Expected at {store_manager}")
|
|
||||||
|
|
||||||
content = store_manager.read_text(encoding="utf-8")
|
|
||||||
try:
|
|
||||||
tree = ast.parse(content, filename=str(store_manager))
|
|
||||||
except SyntaxError as exc:
|
|
||||||
return TestResult("T1a", "CRITICAL",
|
|
||||||
"store_manager.py could not be parsed",
|
|
||||||
str(exc))
|
|
||||||
|
|
||||||
extraction_sites = 0
|
|
||||||
unprotected: list[str] = []
|
|
||||||
|
|
||||||
for func in ast.walk(tree):
|
|
||||||
if not isinstance(func, (ast.FunctionDef, ast.AsyncFunctionDef)):
|
|
||||||
continue
|
|
||||||
|
|
||||||
extract_calls = [
|
|
||||||
node for node in ast.walk(func)
|
|
||||||
if isinstance(node, ast.Call) and isinstance(node.func, ast.Attribute)
|
|
||||||
and node.func.attr in ("extract", "extractall")
|
|
||||||
]
|
|
||||||
if not extract_calls:
|
|
||||||
continue
|
|
||||||
extraction_sites += len(extract_calls)
|
|
||||||
|
|
||||||
guard_lines = [
|
|
||||||
n.lineno for n in ast.walk(func)
|
|
||||||
if isinstance(n, ast.Attribute) and n.attr == "is_relative_to"
|
|
||||||
]
|
|
||||||
has_zip_slip_log = any(
|
|
||||||
isinstance(n, ast.Constant) and isinstance(n.value, str)
|
|
||||||
and "Zip-slip detected" in n.value
|
|
||||||
for n in ast.walk(func)
|
|
||||||
)
|
|
||||||
|
|
||||||
for call in extract_calls:
|
|
||||||
guarded = has_zip_slip_log and any(g < call.lineno for g in guard_lines)
|
|
||||||
if not guarded:
|
|
||||||
unprotected.append(
|
|
||||||
f"{func.name}() line {call.lineno}: {call.func.attr}() call not "
|
|
||||||
f"clearly preceded by an is_relative_to() guard + Zip-slip log "
|
|
||||||
f"in the same function"
|
|
||||||
)
|
|
||||||
|
|
||||||
if extraction_sites == 0:
|
|
||||||
return TestResult("T1a", "WARNING",
|
|
||||||
"No zipfile extract()/extractall() calls found in store_manager.py",
|
|
||||||
"Verify plugin installation no longer extracts zip archives, "
|
|
||||||
"or that this check still targets the right file")
|
|
||||||
|
|
||||||
if unprotected:
|
|
||||||
return TestResult("T1a", "CRITICAL",
|
|
||||||
f"{len(unprotected)} of {extraction_sites} zip extraction "
|
|
||||||
f"call(s) not clearly guarded",
|
|
||||||
"; ".join(unprotected))
|
|
||||||
|
|
||||||
return TestResult("T1a", "PASS",
|
|
||||||
"Zip-slip protection verified",
|
|
||||||
f"All {extraction_sites} extract()/extractall() call(s) in "
|
|
||||||
f"store_manager.py are preceded by an is_relative_to() guard "
|
|
||||||
f"with a Zip-slip log in the same function")
|
|
||||||
|
|
||||||
|
|
||||||
def test_t1b_dangerous_plugin_calls() -> list[TestResult]:
|
|
||||||
"""
|
|
||||||
Scan plugin directories for dangerous function calls (eval, exec).
|
|
||||||
These represent arbitrary code execution risks in plugin code.
|
|
||||||
"""
|
|
||||||
results = []
|
|
||||||
plugin_dirs = [
|
|
||||||
PROJECT_ROOT / "plugins",
|
|
||||||
PROJECT_ROOT / "plugin-repos",
|
|
||||||
]
|
|
||||||
|
|
||||||
violations: list[str] = []
|
|
||||||
files_scanned = 0
|
|
||||||
|
|
||||||
scan_errors: list[str] = []
|
|
||||||
|
|
||||||
for base in plugin_dirs:
|
|
||||||
if not base.exists():
|
|
||||||
continue
|
|
||||||
for plugin_dir in sorted(base.iterdir()):
|
|
||||||
if not plugin_dir.is_dir() or plugin_dir.name.startswith(('.', '_')):
|
|
||||||
continue
|
|
||||||
for py_file in plugin_dir.rglob("*.py"):
|
|
||||||
files_scanned += 1
|
|
||||||
try:
|
|
||||||
source = py_file.read_text(encoding="utf-8")
|
|
||||||
tree = ast.parse(source, filename=str(py_file))
|
|
||||||
for node in ast.walk(tree):
|
|
||||||
if isinstance(node, ast.Call) and isinstance(node.func, ast.Name):
|
|
||||||
if node.func.id in ("eval", "exec"):
|
|
||||||
rel = py_file.relative_to(PROJECT_ROOT)
|
|
||||||
violations.append(
|
|
||||||
f"{rel}:{node.lineno} — {node.func.id}() call")
|
|
||||||
except (SyntaxError, OSError) as exc:
|
|
||||||
# A file we couldn't parse/read was never actually
|
|
||||||
# scanned for eval()/exec() -- that must block this
|
|
||||||
# test, not silently pass as if it were clean.
|
|
||||||
rel = py_file.relative_to(PROJECT_ROOT)
|
|
||||||
scan_errors.append(f"{rel} — {type(exc).__name__}: {exc}")
|
|
||||||
|
|
||||||
if scan_errors:
|
|
||||||
results.append(TestResult(
|
|
||||||
"T1b", "CRITICAL",
|
|
||||||
f"{len(scan_errors)} plugin file(s) could not be scanned for eval()/exec()",
|
|
||||||
"; ".join(scan_errors[:10])
|
|
||||||
))
|
|
||||||
|
|
||||||
if violations:
|
|
||||||
results.append(TestResult(
|
|
||||||
"T1b", "CRITICAL",
|
|
||||||
f"Dangerous function calls found in plugins ({len(violations)} instance(s))",
|
|
||||||
"; ".join(violations[:10])
|
|
||||||
))
|
|
||||||
elif not scan_errors:
|
|
||||||
results.append(TestResult(
|
|
||||||
"T1b", "PASS",
|
|
||||||
"No eval()/exec() calls found in plugins",
|
|
||||||
f"{files_scanned} plugin Python files scanned"
|
|
||||||
))
|
|
||||||
|
|
||||||
return results
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# T2: API Surface Inventory
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def test_t2a_api_surface_inventory() -> TestResult:
|
|
||||||
"""
|
|
||||||
Document the API surface area.
|
|
||||||
|
|
||||||
This app intentionally has no authentication (local-only Raspberry Pi
|
|
||||||
design, documented in web_interface/app.py). This test produces an
|
|
||||||
inventory for audit purposes and warns only if the design-intent comment
|
|
||||||
is removed from app.py (which would indicate someone deleted the rationale
|
|
||||||
without adding auth, rather than a deliberate undocumented change).
|
|
||||||
"""
|
|
||||||
api_file = PROJECT_ROOT / "web_interface" / "blueprints" / "api_v3.py"
|
|
||||||
app_file = PROJECT_ROOT / "web_interface" / "app.py"
|
|
||||||
|
|
||||||
if not api_file.exists():
|
|
||||||
return TestResult("T2a", "WARNING", "api_v3.py not found", str(api_file))
|
|
||||||
|
|
||||||
api_content = api_file.read_text(encoding="utf-8")
|
|
||||||
routes = re.findall(r"@api_v3\.route\('([^']+)'", api_content)
|
|
||||||
|
|
||||||
csrf_documented = False
|
|
||||||
if app_file.exists():
|
|
||||||
app_content = app_file.read_text(encoding="utf-8")
|
|
||||||
csrf_documented = "CSRF protection disabled for local-only" in app_content
|
|
||||||
|
|
||||||
summary = (
|
|
||||||
f"{len(routes)} API routes in api_v3.py. "
|
|
||||||
f"No auth decorators (intentional local-only design). "
|
|
||||||
f"CSRF disabled: {'YES — design intent documented in app.py' if csrf_documented else 'YES — but design intent comment NOT found in app.py'}. "
|
|
||||||
f"Rate limiting: 1000/min."
|
|
||||||
)
|
|
||||||
|
|
||||||
if not csrf_documented:
|
|
||||||
return TestResult(
|
|
||||||
"T2a", "WARNING",
|
|
||||||
"CSRF is disabled but the design-intent comment is missing from app.py",
|
|
||||||
"Add the rationale comment back, or add proper CSRF protection if "
|
|
||||||
"the app is now internet-facing"
|
|
||||||
)
|
|
||||||
|
|
||||||
# There is currently no config mechanism that actually enforces the
|
|
||||||
# local-only boundary the design-intent comment describes -- app.py
|
|
||||||
# hardcodes host='0.0.0.0' unconditionally, so nothing here can confirm
|
|
||||||
# this deployment is in fact LAN-only. Reporting this as mere INFO
|
|
||||||
# understates that: an unauthenticated, CSRF-disabled API surface is a
|
|
||||||
# real risk the moment this ever runs somewhere other than a home LAN,
|
|
||||||
# documented rationale or not.
|
|
||||||
return TestResult(
|
|
||||||
"T2a", "WARNING",
|
|
||||||
"API surface has no auth and CSRF disabled; enforcement of the "
|
|
||||||
"documented local-only boundary cannot be confirmed",
|
|
||||||
summary
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# T3: Secrets & Credential Handling
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
# Patterns that suggest real credentials (must be >8 chars, not placeholders)
|
|
||||||
_SECRET_PATTERNS = [
|
|
||||||
(r'(?i)password\s*=\s*["\'](?!none|empty|placeholder|example|test|default|""|'')[^"\']{8,}["\']', "WARNING", "password"),
|
|
||||||
(r'(?i)api[_-]?key\s*=\s*["\'](?!none|empty|placeholder|YOUR_|example|test)[^"\']{16,}["\']', "WARNING", "api_key"),
|
|
||||||
(r'(?i)secret\s*=\s*["\'](?!none|empty|placeholder|YOUR_|example|test)[^"\']{16,}["\']', "WARNING", "secret"),
|
|
||||||
# Real GitHub token pattern
|
|
||||||
(r'ghp_[a-zA-Z0-9]{36}', "CRITICAL", "github_token"),
|
|
||||||
# Generic long bearer tokens
|
|
||||||
(r'Bearer\s+[a-zA-Z0-9\-_\.]{32,}', "WARNING", "bearer_token"),
|
|
||||||
]
|
|
||||||
|
|
||||||
_TEMPLATE_SKIP_STRINGS = [
|
|
||||||
"YOUR_", "PLACEHOLDER", "_HERE", "example.com", "config_secrets.template",
|
|
||||||
"prove_security", # this file itself
|
|
||||||
]
|
|
||||||
|
|
||||||
_SCAN_DIRS = ["src", "web_interface", "scripts"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_t3a_hardcoded_secrets() -> TestResult:
|
|
||||||
"""Scan source code for hardcoded credentials."""
|
|
||||||
violations: list[str] = []
|
|
||||||
|
|
||||||
for dir_name in _SCAN_DIRS:
|
|
||||||
scan_dir = PROJECT_ROOT / dir_name
|
|
||||||
if not scan_dir.exists():
|
|
||||||
continue
|
|
||||||
for py_file in scan_dir.rglob("*.py"):
|
|
||||||
# Skip test files and this script
|
|
||||||
if "test" in str(py_file).lower() or "prove_security" in str(py_file):
|
|
||||||
continue
|
|
||||||
try:
|
|
||||||
content = py_file.read_text(encoding="utf-8")
|
|
||||||
except OSError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
for pattern, severity, pattern_type in _SECRET_PATTERNS:
|
|
||||||
for match in re.finditer(pattern, content):
|
|
||||||
line_content = match.group(0)
|
|
||||||
# Skip lines containing template placeholder strings.
|
|
||||||
# line_content is only used for this in-memory check --
|
|
||||||
# it must never be stored or included in output below.
|
|
||||||
if any(skip in line_content for skip in _TEMPLATE_SKIP_STRINGS):
|
|
||||||
continue
|
|
||||||
rel = py_file.relative_to(PROJECT_ROOT)
|
|
||||||
line_no = content[: match.start()].count("\n") + 1
|
|
||||||
# Redacted fingerprint lets the same finding be recognized
|
|
||||||
# across scans without ever reporting the matched
|
|
||||||
# credential itself (which would otherwise get published
|
|
||||||
# into CI logs, JSON artifacts, and PR comments -- wider
|
|
||||||
# exposure than the original leak).
|
|
||||||
fingerprint = hashlib.sha256(line_content.encode()).hexdigest()[:12]
|
|
||||||
violations.append(
|
|
||||||
f"[{severity}] {rel}:{line_no} — {pattern_type} "
|
|
||||||
f"(fingerprint {fingerprint})"
|
|
||||||
)
|
|
||||||
|
|
||||||
critical_violations = [v for v in violations if "[CRITICAL]" in v]
|
|
||||||
if critical_violations:
|
|
||||||
return TestResult(
|
|
||||||
"T3a", "CRITICAL",
|
|
||||||
f"Hardcoded secrets found ({len(critical_violations)} critical)",
|
|
||||||
"; ".join(critical_violations[:5])
|
|
||||||
)
|
|
||||||
if violations:
|
|
||||||
return TestResult(
|
|
||||||
"T3a", "WARNING",
|
|
||||||
f"Potential hardcoded secrets found ({len(violations)} instance(s))",
|
|
||||||
"; ".join(violations[:5])
|
|
||||||
)
|
|
||||||
|
|
||||||
return TestResult("T3a", "PASS", "No hardcoded secrets detected",
|
|
||||||
f"Scanned {', '.join(_SCAN_DIRS)}")
|
|
||||||
|
|
||||||
|
|
||||||
def test_t3b_plaintext_password_storage() -> TestResult:
|
|
||||||
"""
|
|
||||||
Check for user account password storage without hashing.
|
|
||||||
|
|
||||||
The LEDMatrix app has no user account system, so this should produce INFO.
|
|
||||||
It would only CRITICAL if someone added user auth and stored passwords without hashing.
|
|
||||||
|
|
||||||
We require all three of: a password *variable assignment or DB operation*,
|
|
||||||
a clear storage call (INSERT / db commit / ORM save), and no hashing lib present
|
|
||||||
— to avoid false positives from files that contain 'password' for WiFi handling
|
|
||||||
and '.save()' for image/file saving in unrelated functions.
|
|
||||||
"""
|
|
||||||
hashing_libs = ["bcrypt", "argon2", "pbkdf2", "scrypt",
|
|
||||||
"generate_password_hash", "hashpw", "make_password"]
|
|
||||||
# Patterns that indicate password being stored in a database / ORM context.
|
|
||||||
# Must be specific enough to avoid matching set.add(), file.save(), etc.
|
|
||||||
db_storage_patterns = ["INSERT INTO", "db.session", "session.add(", "session.commit(", "orm.save"]
|
|
||||||
|
|
||||||
password_storage_found = False
|
|
||||||
|
|
||||||
for dir_name in _SCAN_DIRS:
|
|
||||||
scan_dir = PROJECT_ROOT / dir_name
|
|
||||||
if not scan_dir.exists():
|
|
||||||
continue
|
|
||||||
for py_file in scan_dir.rglob("*.py"):
|
|
||||||
try:
|
|
||||||
content = py_file.read_text(encoding="utf-8")
|
|
||||||
except OSError:
|
|
||||||
continue
|
|
||||||
# Require DB/ORM context specifically — not just any .save() call
|
|
||||||
if ("password" in content.lower() and
|
|
||||||
any(store in content for store in db_storage_patterns) and
|
|
||||||
not any(h in content for h in hashing_libs)):
|
|
||||||
password_storage_found = True
|
|
||||||
|
|
||||||
if password_storage_found:
|
|
||||||
return TestResult(
|
|
||||||
"T3b", "CRITICAL",
|
|
||||||
"Potential plaintext password storage in database/ORM detected",
|
|
||||||
"Found password + database storage operations without a recognized hashing library"
|
|
||||||
)
|
|
||||||
|
|
||||||
return TestResult("T3b", "INFO",
|
|
||||||
"No plaintext password storage detected",
|
|
||||||
"App has no user account system — expected result")
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# T4: Path Traversal
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def test_t4a_path_traversal() -> TestResult:
|
|
||||||
"""
|
|
||||||
Verify static file serving uses send_from_directory (safe) rather than
|
|
||||||
open() with user-supplied paths. Also checks for extractall() calls that
|
|
||||||
lack the is_relative_to() guard.
|
|
||||||
"""
|
|
||||||
issues: list[str] = []
|
|
||||||
|
|
||||||
app_file = PROJECT_ROOT / "web_interface" / "app.py"
|
|
||||||
if app_file.exists():
|
|
||||||
content = app_file.read_text(encoding="utf-8")
|
|
||||||
# The file-serve route should use send_from_directory or commonpath
|
|
||||||
if "send_from_directory" not in content and "commonpath" not in content:
|
|
||||||
issues.append("app.py: file-serve routes may not use send_from_directory/commonpath")
|
|
||||||
|
|
||||||
# Check all extractall() calls have a preceding is_relative_to guard
|
|
||||||
for py_file in (PROJECT_ROOT / "src").rglob("*.py"):
|
|
||||||
try:
|
|
||||||
content = py_file.read_text(encoding="utf-8")
|
|
||||||
except OSError:
|
|
||||||
continue
|
|
||||||
if "extractall(" in content and "is_relative_to" not in content:
|
|
||||||
rel = py_file.relative_to(PROJECT_ROOT)
|
|
||||||
issues.append(f"{rel}: extractall() without is_relative_to() guard")
|
|
||||||
|
|
||||||
if issues:
|
|
||||||
return TestResult(
|
|
||||||
"T4a", "WARNING",
|
|
||||||
f"Potential path traversal patterns found ({len(issues)})",
|
|
||||||
"; ".join(issues)
|
|
||||||
)
|
|
||||||
|
|
||||||
return TestResult("T4a", "PASS",
|
|
||||||
"Path traversal mitigations verified",
|
|
||||||
"send_from_directory/commonpath used for file serving; "
|
|
||||||
"extractall() calls have is_relative_to() guards")
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# T5: Auth Bypass Patterns
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def test_t5a_auth_bypass_patterns() -> TestResult:
|
|
||||||
"""
|
|
||||||
Look for broken auth bypass patterns — not the intentional no-auth design
|
|
||||||
(T2a covers that), but patterns that suggest auth was INTENDED to exist
|
|
||||||
but has an exploitable bypass: broad substring matching, debug-mode skips,
|
|
||||||
or if-True conditions.
|
|
||||||
"""
|
|
||||||
bypass_signals = [
|
|
||||||
(r'if\s+True\s*:', "if True: bypass"),
|
|
||||||
(r'if\s+debug\s*:', "debug-mode auth skip"),
|
|
||||||
(r'request\.path\s+in\s+', "substring path matching in auth (Huntarr pattern)"),
|
|
||||||
(r'EXEMPT_ROUTES\s*=', "exempt routes list"),
|
|
||||||
]
|
|
||||||
|
|
||||||
findings: list[str] = []
|
|
||||||
|
|
||||||
for dir_name in ["src", "web_interface"]:
|
|
||||||
scan_dir = PROJECT_ROOT / dir_name
|
|
||||||
if not scan_dir.exists():
|
|
||||||
continue
|
|
||||||
for py_file in scan_dir.rglob("*.py"):
|
|
||||||
try:
|
|
||||||
content = py_file.read_text(encoding="utf-8")
|
|
||||||
except OSError:
|
|
||||||
continue
|
|
||||||
for pattern, label in bypass_signals:
|
|
||||||
if re.search(pattern, content):
|
|
||||||
# Only flag if the file also contains auth-related terms
|
|
||||||
if any(auth in content.lower() for auth in
|
|
||||||
["auth", "login", "authenticate", "token", "permission"]):
|
|
||||||
rel = py_file.relative_to(PROJECT_ROOT)
|
|
||||||
findings.append(f"{rel}: {label}")
|
|
||||||
|
|
||||||
if findings:
|
|
||||||
return TestResult(
|
|
||||||
"T5a", "WARNING",
|
|
||||||
f"Potential auth bypass patterns found ({len(findings)})",
|
|
||||||
"; ".join(findings[:5])
|
|
||||||
)
|
|
||||||
|
|
||||||
return TestResult("T5a", "PASS",
|
|
||||||
"No auth bypass patterns detected",
|
|
||||||
"Checked src/ and web_interface/ for bypass signals")
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# T6: Docker / Container Hardening
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def test_t6_docker_hardening() -> TestResult:
|
|
||||||
"""Container security — skipped if no Dockerfile exists."""
|
|
||||||
dockerfile = PROJECT_ROOT / "Dockerfile"
|
|
||||||
if not dockerfile.exists():
|
|
||||||
return TestResult("T6", "SKIP",
|
|
||||||
"No Dockerfile found — container security scan not applicable",
|
|
||||||
"If Docker support is added in future, enable hadolint/trivy scanning "
|
|
||||||
"in .github/workflows/security-audit.yml")
|
|
||||||
|
|
||||||
content = dockerfile.read_text(encoding="utf-8")
|
|
||||||
issues: list[str] = []
|
|
||||||
|
|
||||||
# Check for non-root USER directive
|
|
||||||
user_lines = [l for l in content.splitlines() if l.strip().startswith("USER")]
|
|
||||||
if not user_lines or user_lines[-1].strip() == "USER root":
|
|
||||||
issues.append("Container runs as root — use USER directive to drop privileges")
|
|
||||||
|
|
||||||
# Check for pinned base image tags. A tag (even a specific version, not
|
|
||||||
# just :latest) is mutable -- the same tag can point to a different
|
|
||||||
# image later. Only a @sha256 digest is truly immutable/reproducible.
|
|
||||||
from_lines = [line for line in content.splitlines() if line.strip().startswith("FROM")]
|
|
||||||
for from_line in from_lines:
|
|
||||||
parts = from_line.split()
|
|
||||||
# FROM [--platform=<platform>] <image> [AS <name>] -- skip an
|
|
||||||
# optional --platform= flag so it's never mistaken for the image
|
|
||||||
# token itself (which would falsely report it as unpinned).
|
|
||||||
image_parts = [p for p in parts[1:] if not p.startswith("--platform=")]
|
|
||||||
if image_parts:
|
|
||||||
image = image_parts[0]
|
|
||||||
if "@sha256:" not in image:
|
|
||||||
issues.append(f"Base image not pinned to a digest: {image}")
|
|
||||||
|
|
||||||
if issues:
|
|
||||||
return TestResult("T6", "WARNING",
|
|
||||||
f"Dockerfile hardening issues ({len(issues)})",
|
|
||||||
"; ".join(issues))
|
|
||||||
|
|
||||||
return TestResult("T6", "PASS", "Dockerfile hardening checks passed", "")
|
|
||||||
|
|
||||||
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
# Runner
|
|
||||||
# ─────────────────────────────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
def main() -> int:
|
|
||||||
parser = argparse.ArgumentParser(
|
|
||||||
description="LEDMatrix security proof tests",
|
|
||||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
||||||
)
|
|
||||||
parser.add_argument("--output", "-o", default=None,
|
|
||||||
help="Write JSON results to this file")
|
|
||||||
parser.add_argument("--verbose", "-v", action="store_true",
|
|
||||||
help="Show details for each check")
|
|
||||||
args = parser.parse_args()
|
|
||||||
|
|
||||||
print("=" * 60)
|
|
||||||
print("LEDMatrix Security Proof Tests")
|
|
||||||
print(f"Project root: {PROJECT_ROOT}")
|
|
||||||
print("=" * 60)
|
|
||||||
|
|
||||||
all_results: list[TestResult] = []
|
|
||||||
|
|
||||||
# Run all test groups
|
|
||||||
all_results.append(test_t1a_zip_slip_protection())
|
|
||||||
all_results.extend(test_t1b_dangerous_plugin_calls())
|
|
||||||
all_results.append(test_t2a_api_surface_inventory())
|
|
||||||
all_results.append(test_t3a_hardcoded_secrets())
|
|
||||||
all_results.append(test_t3b_plaintext_password_storage())
|
|
||||||
all_results.append(test_t4a_path_traversal())
|
|
||||||
all_results.append(test_t5a_auth_bypass_patterns())
|
|
||||||
all_results.append(test_t6_docker_hardening())
|
|
||||||
|
|
||||||
# Print results
|
|
||||||
print()
|
|
||||||
for r in all_results:
|
|
||||||
line = f" {r.icon} [{r.severity:<8}] {r.test_id}: {r.message}"
|
|
||||||
print(line)
|
|
||||||
if args.verbose and r.details:
|
|
||||||
print(f" {r.details}")
|
|
||||||
|
|
||||||
# Tally
|
|
||||||
critical = [r for r in all_results if r.severity == "CRITICAL"]
|
|
||||||
warnings = [r for r in all_results if r.severity == "WARNING"]
|
|
||||||
passed = [r for r in all_results if r.severity == "PASS"]
|
|
||||||
skipped = [r for r in all_results if r.severity == "SKIP"]
|
|
||||||
|
|
||||||
print()
|
|
||||||
print(f" Results: {len(passed)} PASS {len(warnings)} WARN "
|
|
||||||
f"{len(critical)} CRITICAL {len(skipped)} SKIP")
|
|
||||||
|
|
||||||
# Write JSON output
|
|
||||||
if args.output:
|
|
||||||
output_data = [r.to_dict() for r in all_results]
|
|
||||||
Path(args.output).write_text(
|
|
||||||
json.dumps(output_data, indent=2), encoding="utf-8"
|
|
||||||
)
|
|
||||||
print(f" Results written to: {args.output}")
|
|
||||||
|
|
||||||
if critical:
|
|
||||||
print(f"\n 🚨 {len(critical)} CRITICAL issue(s) found — blocking")
|
|
||||||
return 1
|
|
||||||
|
|
||||||
if warnings:
|
|
||||||
print(f"\n ⚠️ {len(warnings)} warning(s) found — non-blocking")
|
|
||||||
|
|
||||||
print("\n ✅ All checks passed (warnings are non-blocking)")
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
sys.exit(main())
|
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
"""
|
||||||
|
Background Cache Mixin for Sports Managers
|
||||||
|
|
||||||
|
This mixin provides common caching functionality to eliminate code duplication
|
||||||
|
across all sports managers. It implements the background service cache pattern
|
||||||
|
where Recent/Upcoming managers consume data from the background service cache.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import time
|
||||||
|
from typing import Dict, Optional, Any, Callable
|
||||||
|
|
||||||
|
|
||||||
|
class BackgroundCacheMixin:
|
||||||
|
"""
|
||||||
|
Mixin class that provides background service cache functionality to sports managers.
|
||||||
|
|
||||||
|
This mixin eliminates code duplication by providing a common implementation
|
||||||
|
for the background service cache pattern used across all sports managers.
|
||||||
|
|
||||||
|
Note: For non-sports managers (weather, stocks, news, etc.), use
|
||||||
|
GenericCacheMixin instead. See src/generic_cache_mixin.py for details.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def _fetch_data_with_background_cache(self,
|
||||||
|
sport_key: str,
|
||||||
|
api_fetch_method: Callable,
|
||||||
|
live_manager_class: type = None) -> Optional[Dict]:
|
||||||
|
"""
|
||||||
|
Common logic for fetching data with background service cache support.
|
||||||
|
|
||||||
|
This method implements the background service cache pattern:
|
||||||
|
1. Live managers always fetch fresh data
|
||||||
|
2. Recent/Upcoming managers try background cache first
|
||||||
|
3. Fallback to direct API call if background data unavailable
|
||||||
|
|
||||||
|
Args:
|
||||||
|
sport_key: Sport identifier (e.g., 'nba', 'nfl', 'ncaa_fb')
|
||||||
|
api_fetch_method: Method to call for direct API fetch
|
||||||
|
live_manager_class: Class to check if this is a live manager
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Cached or fresh data from API
|
||||||
|
"""
|
||||||
|
start_time = time.time()
|
||||||
|
cache_hit = False
|
||||||
|
cache_source = None
|
||||||
|
|
||||||
|
try:
|
||||||
|
# For Live managers, always fetch fresh data
|
||||||
|
if live_manager_class and isinstance(self, live_manager_class):
|
||||||
|
self.logger.info(f"[{sport_key.upper()}] Live manager - fetching fresh data")
|
||||||
|
result = api_fetch_method(use_cache=False)
|
||||||
|
cache_source = "live_fresh"
|
||||||
|
else:
|
||||||
|
# For Recent/Upcoming managers, try background service cache first
|
||||||
|
cache_key = self.cache_manager.generate_sport_cache_key(sport_key)
|
||||||
|
|
||||||
|
# Check if background service has fresh data
|
||||||
|
if self.cache_manager.is_background_data_available(cache_key, sport_key):
|
||||||
|
cached_data = self.cache_manager.get_background_cached_data(cache_key, sport_key)
|
||||||
|
if cached_data:
|
||||||
|
self.logger.info(f"[{sport_key.upper()}] Using background service cache for {cache_key}")
|
||||||
|
result = cached_data
|
||||||
|
cache_hit = True
|
||||||
|
cache_source = "background_cache"
|
||||||
|
else:
|
||||||
|
self.logger.warning(f"[{sport_key.upper()}] Background cache check passed but no data returned for {cache_key}")
|
||||||
|
result = None
|
||||||
|
cache_source = "background_miss"
|
||||||
|
else:
|
||||||
|
self.logger.info(f"[{sport_key.upper()}] Background data not available for {cache_key}")
|
||||||
|
result = None
|
||||||
|
cache_source = "background_unavailable"
|
||||||
|
|
||||||
|
# Fallback to direct API call if background data not available
|
||||||
|
if result is None:
|
||||||
|
self.logger.info(f"[{sport_key.upper()}] Fetching directly from API for {cache_key}")
|
||||||
|
result = api_fetch_method(use_cache=True)
|
||||||
|
cache_source = "api_fallback"
|
||||||
|
|
||||||
|
# Record performance metrics
|
||||||
|
duration = time.time() - start_time
|
||||||
|
self.cache_manager.record_fetch_time(duration)
|
||||||
|
|
||||||
|
# Log performance metrics
|
||||||
|
self._log_fetch_performance(sport_key, duration, cache_hit, cache_source)
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
duration = time.time() - start_time
|
||||||
|
self.logger.error(f"[{sport_key.upper()}] Error in background cache fetch after {duration:.2f}s: {e}")
|
||||||
|
self.cache_manager.record_fetch_time(duration)
|
||||||
|
raise
|
||||||
|
|
||||||
|
def _log_fetch_performance(self, sport_key: str, duration: float, cache_hit: bool, cache_source: str):
|
||||||
|
"""
|
||||||
|
Log detailed performance metrics for fetch operations.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
sport_key: Sport identifier
|
||||||
|
duration: Fetch operation duration in seconds
|
||||||
|
cache_hit: Whether this was a cache hit
|
||||||
|
cache_source: Source of the data (background_cache, api_fallback, etc.)
|
||||||
|
"""
|
||||||
|
# Log basic performance info
|
||||||
|
self.logger.info(f"[{sport_key.upper()}] Fetch completed in {duration:.2f}s "
|
||||||
|
f"(cache_hit={cache_hit}, source={cache_source})")
|
||||||
|
|
||||||
|
# Log detailed metrics every 10 operations
|
||||||
|
if hasattr(self, '_fetch_count'):
|
||||||
|
self._fetch_count += 1
|
||||||
|
else:
|
||||||
|
self._fetch_count = 1
|
||||||
|
|
||||||
|
if self._fetch_count % 10 == 0:
|
||||||
|
metrics = self.cache_manager.get_cache_metrics()
|
||||||
|
self.logger.info(f"[{sport_key.upper()}] Cache Performance Summary - "
|
||||||
|
f"Hit Rate: {metrics['cache_hit_rate']:.2%}, "
|
||||||
|
f"Background Hit Rate: {metrics['background_hit_rate']:.2%}, "
|
||||||
|
f"API Calls Saved: {metrics['api_calls_saved']}")
|
||||||
|
|
||||||
|
def get_cache_performance_summary(self) -> Dict[str, Any]:
|
||||||
|
"""
|
||||||
|
Get cache performance summary for this manager.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Dictionary containing cache performance metrics
|
||||||
|
"""
|
||||||
|
return self.cache_manager.get_cache_metrics()
|
||||||
|
|
||||||
|
def log_cache_performance(self):
|
||||||
|
"""Log current cache performance metrics."""
|
||||||
|
self.cache_manager.log_cache_metrics()
|
||||||
@@ -0,0 +1,328 @@
|
|||||||
|
"""
|
||||||
|
Example: Basketball Plugin using LEDMatrix Common Helpers
|
||||||
|
|
||||||
|
This example shows how to refactor the basketball plugin to use the
|
||||||
|
ledmatrix-common package for cleaner, more maintainable code.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Dict, List, Optional
|
||||||
|
|
||||||
|
|
||||||
|
# Import common helpers
|
||||||
|
from src.common import (
|
||||||
|
LogoHelper, TextHelper, APIHelper, DisplayHelper,
|
||||||
|
GameHelper, ConfigHelper
|
||||||
|
)
|
||||||
|
from src.plugin_system.base_plugin import BasePlugin
|
||||||
|
|
||||||
|
|
||||||
|
class BasketballPluginManager(BasePlugin):
|
||||||
|
"""
|
||||||
|
Basketball scoreboard plugin using LEDMatrix Common helpers.
|
||||||
|
|
||||||
|
This version is much cleaner and more maintainable than the original
|
||||||
|
because it delegates common functionality to the shared helpers.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
plugin_id: str,
|
||||||
|
config: Dict[str, Any],
|
||||||
|
display_manager,
|
||||||
|
cache_manager,
|
||||||
|
plugin_manager
|
||||||
|
):
|
||||||
|
"""Initialize the basketball plugin with common helpers."""
|
||||||
|
super().__init__(plugin_id, config, display_manager, cache_manager, plugin_manager)
|
||||||
|
|
||||||
|
# Get display dimensions
|
||||||
|
self.display_width = display_manager.matrix.width
|
||||||
|
self.display_height = display_manager.matrix.height
|
||||||
|
|
||||||
|
# Initialize common helpers
|
||||||
|
self._init_helpers()
|
||||||
|
|
||||||
|
# Load configuration
|
||||||
|
self._load_config()
|
||||||
|
|
||||||
|
# State tracking
|
||||||
|
self.current_games = []
|
||||||
|
self.current_game = None
|
||||||
|
|
||||||
|
# Log initialization
|
||||||
|
enabled_leagues = [k for k, v in self.league_configs.items() if v['enabled']]
|
||||||
|
self.logger.info(f"Basketball plugin initialized with leagues: {enabled_leagues}")
|
||||||
|
|
||||||
|
def _init_helpers(self):
|
||||||
|
"""Initialize all common helpers."""
|
||||||
|
# Logo helper for team logos
|
||||||
|
self.logo_helper = LogoHelper(
|
||||||
|
display_width=self.display_width,
|
||||||
|
display_height=self.display_height,
|
||||||
|
logger=self.logger
|
||||||
|
)
|
||||||
|
|
||||||
|
# Text helper for rendering
|
||||||
|
self.text_helper = TextHelper(logger=self.logger)
|
||||||
|
self.fonts = self.text_helper.load_fonts()
|
||||||
|
|
||||||
|
# API helper for ESPN data
|
||||||
|
self.api_helper = APIHelper(
|
||||||
|
cache_manager=self.cache_manager,
|
||||||
|
logger=self.logger
|
||||||
|
)
|
||||||
|
|
||||||
|
# Display helper for layouts
|
||||||
|
self.display_helper = DisplayHelper(
|
||||||
|
display_width=self.display_width,
|
||||||
|
display_height=self.display_height,
|
||||||
|
logger=self.logger
|
||||||
|
)
|
||||||
|
|
||||||
|
# Game helper for data processing
|
||||||
|
self.game_helper = GameHelper(
|
||||||
|
timezone_str=self.config.get('timezone', 'UTC'),
|
||||||
|
logger=self.logger
|
||||||
|
)
|
||||||
|
|
||||||
|
# Config helper for configuration management
|
||||||
|
self.config_helper = ConfigHelper(logger=self.logger)
|
||||||
|
|
||||||
|
def _load_config(self):
|
||||||
|
"""Load and validate configuration."""
|
||||||
|
# Get basketball-specific config
|
||||||
|
basketball_config = self.config_helper.get_sports_config(self.config, 'basketball')
|
||||||
|
|
||||||
|
# Build league configurations
|
||||||
|
self.league_configs = {
|
||||||
|
'nba': {
|
||||||
|
'enabled': basketball_config.get('nba_enabled', True),
|
||||||
|
'url': 'https://site.api.espn.com/apis/site/v2/sports/basketball/nba/scoreboard',
|
||||||
|
'logo_dir': Path('assets/sports/nba_logos'),
|
||||||
|
'favorite_teams': basketball_config.get('nba_favorite_teams', []),
|
||||||
|
'display_modes': {
|
||||||
|
'nba_live': basketball_config.get('nba_display_modes_live', True),
|
||||||
|
'nba_recent': basketball_config.get('nba_display_modes_recent', True),
|
||||||
|
'nba_upcoming': basketball_config.get('nba_display_modes_upcoming', True),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
'wnba': {
|
||||||
|
'enabled': basketball_config.get('wnba_enabled', False),
|
||||||
|
'url': 'https://site.api.espn.com/apis/site/v2/sports/basketball/wnba/scoreboard',
|
||||||
|
'logo_dir': Path('assets/sports/wnba_logos'),
|
||||||
|
'favorite_teams': basketball_config.get('wnba_favorite_teams', []),
|
||||||
|
'display_modes': {
|
||||||
|
'wnba_live': basketball_config.get('wnba_display_modes_live', True),
|
||||||
|
'wnba_recent': basketball_config.get('wnba_display_modes_recent', True),
|
||||||
|
'wnba_upcoming': basketball_config.get('wnba_display_modes_upcoming', True),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
'ncaam': {
|
||||||
|
'enabled': basketball_config.get('ncaam_basketball_enabled', False),
|
||||||
|
'url': 'https://site.api.espn.com/apis/site/v2/sports/basketball/mens-college-basketball/scoreboard',
|
||||||
|
'logo_dir': Path('assets/sports/ncaa_logos'),
|
||||||
|
'favorite_teams': basketball_config.get('ncaam_basketball_favorite_teams', []),
|
||||||
|
'display_modes': {
|
||||||
|
'ncaam_basketball_live': basketball_config.get('ncaam_basketball_display_modes_live', True),
|
||||||
|
'ncaam_basketball_recent': basketball_config.get('ncaam_basketball_display_modes_recent', True),
|
||||||
|
'ncaam_basketball_upcoming': basketball_config.get('ncaam_basketball_display_modes_upcoming', True),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
'ncaaw': {
|
||||||
|
'enabled': basketball_config.get('ncaaw_basketball_enabled', False),
|
||||||
|
'url': 'https://site.api.espn.com/apis/site/v2/sports/basketball/womens-college-basketball/scoreboard',
|
||||||
|
'logo_dir': Path('assets/sports/ncaa_logos'),
|
||||||
|
'favorite_teams': basketball_config.get('ncaaw_basketball_favorite_teams', []),
|
||||||
|
'display_modes': {
|
||||||
|
'ncaaw_basketball_live': basketball_config.get('ncaaw_basketball_display_modes_live', True),
|
||||||
|
'ncaaw_basketball_recent': basketball_config.get('ncaaw_basketball_display_modes_recent', True),
|
||||||
|
'ncaaw_basketball_upcoming': basketball_config.get('ncaaw_basketball_display_modes_upcoming', True),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
def update(self) -> None:
|
||||||
|
"""Update game data for all enabled leagues."""
|
||||||
|
try:
|
||||||
|
all_games = []
|
||||||
|
|
||||||
|
for league_key, league_config in self.league_configs.items():
|
||||||
|
if not league_config['enabled']:
|
||||||
|
continue
|
||||||
|
|
||||||
|
games = self._fetch_league_games(league_key, league_config)
|
||||||
|
for game in games:
|
||||||
|
game['league_key'] = league_key
|
||||||
|
game['league_config'] = league_config
|
||||||
|
all_games.extend(games)
|
||||||
|
|
||||||
|
self.current_games = all_games
|
||||||
|
self.logger.debug(f"Updated basketball data: {len(all_games)} total games")
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(f"Error updating basketball data: {e}", exc_info=True)
|
||||||
|
|
||||||
|
def _fetch_league_games(self, league_key: str, league_config: Dict) -> List[Dict]:
|
||||||
|
"""Fetch games for a specific league using API helper."""
|
||||||
|
try:
|
||||||
|
# Use API helper to fetch ESPN data with caching
|
||||||
|
data = self.api_helper.fetch_espn_scoreboard(
|
||||||
|
sport='basketball',
|
||||||
|
league=league_key,
|
||||||
|
cache_key=f"basketball_{league_key}",
|
||||||
|
cache_ttl=300 # 5 minutes cache
|
||||||
|
)
|
||||||
|
|
||||||
|
if not data:
|
||||||
|
return []
|
||||||
|
|
||||||
|
# Use game helper to process events
|
||||||
|
events = data.get('events', [])
|
||||||
|
games = self.game_helper.process_games(events, sport='basketball')
|
||||||
|
|
||||||
|
# Add logo paths to games
|
||||||
|
for game in games:
|
||||||
|
logo_dir = league_config['logo_dir']
|
||||||
|
game['home_logo_path'] = logo_dir / f"{game['home_abbr']}.png"
|
||||||
|
game['away_logo_path'] = logo_dir / f"{game['away_abbr']}.png"
|
||||||
|
|
||||||
|
return games
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(f"Error fetching {league_key} games: {e}", exc_info=True)
|
||||||
|
return []
|
||||||
|
|
||||||
|
def display(self, force_clear: bool = False, display_mode: str = None) -> None:
|
||||||
|
"""Display basketball games using display helper."""
|
||||||
|
try:
|
||||||
|
mode = display_mode or self._determine_display_mode()
|
||||||
|
|
||||||
|
if not mode:
|
||||||
|
self._display_no_games()
|
||||||
|
return
|
||||||
|
|
||||||
|
# Filter games for mode
|
||||||
|
filtered_games = self._filter_games_for_mode(mode)
|
||||||
|
|
||||||
|
if not filtered_games:
|
||||||
|
self._display_no_games()
|
||||||
|
return
|
||||||
|
|
||||||
|
# Display first game
|
||||||
|
self.current_game = filtered_games[0]
|
||||||
|
self._draw_scorebug_layout(self.current_game, force_clear)
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(f"Error displaying game: {e}", exc_info=True)
|
||||||
|
|
||||||
|
def _determine_display_mode(self) -> Optional[str]:
|
||||||
|
"""Determine display mode based on available games."""
|
||||||
|
# Priority: live > recent > upcoming
|
||||||
|
for game in self.current_games:
|
||||||
|
if game.get('is_live'):
|
||||||
|
return f"{game['league_key']}_live"
|
||||||
|
for game in self.current_games:
|
||||||
|
if game.get('is_final'):
|
||||||
|
return f"{game['league_key']}_recent"
|
||||||
|
for game in self.current_games:
|
||||||
|
if game.get('is_upcoming'):
|
||||||
|
return f"{game['league_key']}_upcoming"
|
||||||
|
return None
|
||||||
|
|
||||||
|
def _filter_games_for_mode(self, mode: str) -> List[Dict]:
|
||||||
|
"""Filter games based on display mode."""
|
||||||
|
filtered = []
|
||||||
|
|
||||||
|
for game in self.current_games:
|
||||||
|
league_config = game.get('league_config', {})
|
||||||
|
display_modes = league_config.get('display_modes', {})
|
||||||
|
|
||||||
|
if mode in display_modes and display_modes[mode]:
|
||||||
|
if 'live' in mode and game.get('is_live'):
|
||||||
|
filtered.append(game)
|
||||||
|
elif 'recent' in mode and game.get('is_final'):
|
||||||
|
filtered.append(game)
|
||||||
|
elif 'upcoming' in mode and game.get('is_upcoming'):
|
||||||
|
filtered.append(game)
|
||||||
|
|
||||||
|
return filtered[:5]
|
||||||
|
|
||||||
|
def _draw_scorebug_layout(self, game: Dict, force_clear: bool = False) -> None:
|
||||||
|
"""Draw the basketball scorebug layout using display helper."""
|
||||||
|
try:
|
||||||
|
# Load logos using logo helper
|
||||||
|
home_logo = self.logo_helper.load_logo(
|
||||||
|
game['home_abbr'],
|
||||||
|
game['home_logo_path']
|
||||||
|
)
|
||||||
|
away_logo = self.logo_helper.load_logo(
|
||||||
|
game['away_abbr'],
|
||||||
|
game['away_logo_path']
|
||||||
|
)
|
||||||
|
|
||||||
|
if not home_logo or not away_logo:
|
||||||
|
self.logger.error("Failed to load logos")
|
||||||
|
self._display_error("Logo Error")
|
||||||
|
return
|
||||||
|
|
||||||
|
# Use display helper to create scorebug layout
|
||||||
|
final_img = self.display_helper.draw_scorebug_layout(
|
||||||
|
game_data=game,
|
||||||
|
fonts=self.fonts,
|
||||||
|
home_logo=home_logo,
|
||||||
|
away_logo=away_logo
|
||||||
|
)
|
||||||
|
|
||||||
|
# Display the image
|
||||||
|
self.display_manager.image.paste(final_img, (0, 0))
|
||||||
|
self.display_manager.update_display()
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(f"Error drawing scorebug: {e}", exc_info=True)
|
||||||
|
|
||||||
|
def _display_no_games(self) -> None:
|
||||||
|
"""Display 'no games' message using display helper."""
|
||||||
|
try:
|
||||||
|
img = self.display_helper.draw_no_data_message("No Games")
|
||||||
|
self.display_manager.image = img.copy()
|
||||||
|
self.display_manager.update_display()
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(f"Error displaying no games: {e}", exc_info=True)
|
||||||
|
|
||||||
|
def _display_error(self, message: str) -> None:
|
||||||
|
"""Display error message using display helper."""
|
||||||
|
try:
|
||||||
|
img = self.display_helper.draw_error_message(message)
|
||||||
|
self.display_manager.image = img.copy()
|
||||||
|
self.display_manager.update_display()
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(f"Error displaying error message: {e}", exc_info=True)
|
||||||
|
|
||||||
|
def get_display_duration(self) -> float:
|
||||||
|
"""Get display duration."""
|
||||||
|
return self.config.get('display_duration', 15)
|
||||||
|
|
||||||
|
def cleanup(self) -> None:
|
||||||
|
"""Cleanup resources."""
|
||||||
|
self.current_games = []
|
||||||
|
self.logger.info("Basketball plugin cleaned up")
|
||||||
|
|
||||||
|
|
||||||
|
# Example usage and benefits:
|
||||||
|
"""
|
||||||
|
Benefits of using LEDMatrix Common helpers:
|
||||||
|
|
||||||
|
1. **Cleaner Code**: The plugin is much shorter and more readable
|
||||||
|
2. **Reusable Components**: Common functionality is shared across plugins
|
||||||
|
3. **Better Testing**: Each helper can be tested independently
|
||||||
|
4. **Easier Maintenance**: Bug fixes in helpers benefit all plugins
|
||||||
|
5. **Consistent Behavior**: All plugins use the same underlying logic
|
||||||
|
6. **Reduced Dependencies**: Plugins don't need to import LEDMatrix core
|
||||||
|
7. **Better Error Handling**: Centralized error handling in helpers
|
||||||
|
8. **Configuration Management**: Consistent config handling across plugins
|
||||||
|
|
||||||
|
The original basketball plugin was 326 lines. This version is much cleaner
|
||||||
|
and delegates most functionality to the common helpers, making it easier to
|
||||||
|
maintain and extend.
|
||||||
|
"""
|
||||||
@@ -146,60 +146,6 @@ def ensure_file_permissions(path: Path, mode: int = 0o644) -> None:
|
|||||||
raise
|
raise
|
||||||
|
|
||||||
|
|
||||||
_shared_group_gid_cache: Optional[int] = None
|
|
||||||
|
|
||||||
|
|
||||||
def get_shared_group_gid() -> Optional[int]:
|
|
||||||
"""
|
|
||||||
Return the gid that should own config/secrets files shared between the
|
|
||||||
root-run ``ledmatrix.service`` (main display) and the non-root user that
|
|
||||||
``ledmatrix-web.service`` runs as (see install_web_service.sh, which sets
|
|
||||||
``User=$SUDO_USER``).
|
|
||||||
|
|
||||||
Resolved once from the project root directory's current group (normally
|
|
||||||
the login user's group from the initial ``git clone``), since that user
|
|
||||||
is stable across reinstalls unlike any single file's ownership.
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
The gid, or None if it cannot be determined.
|
|
||||||
"""
|
|
||||||
global _shared_group_gid_cache
|
|
||||||
if _shared_group_gid_cache is not None:
|
|
||||||
return _shared_group_gid_cache
|
|
||||||
try:
|
|
||||||
project_root = Path(__file__).resolve().parent.parent.parent
|
|
||||||
_shared_group_gid_cache = project_root.stat().st_gid
|
|
||||||
return _shared_group_gid_cache
|
|
||||||
except OSError:
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def ensure_shared_group_ownership(path: Path) -> None:
|
|
||||||
"""
|
|
||||||
Best-effort chgrp of ``path`` to the shared group (see
|
|
||||||
:func:`get_shared_group_gid`) when running as root.
|
|
||||||
|
|
||||||
Only root can change a file's group to one the calling process isn't a
|
|
||||||
member of, which is exactly the case that causes the web interface
|
|
||||||
(running as a non-root user) to get ``PermissionError`` reading files
|
|
||||||
the root-run display service just wrote with a 0o640/2775 mode: the mode
|
|
||||||
is group-readable, but without this the group is root's, not the web
|
|
||||||
user's. Silently does nothing if not running as root or on any error —
|
|
||||||
this is a hardening step, not a required one.
|
|
||||||
"""
|
|
||||||
if os.geteuid() != 0:
|
|
||||||
return
|
|
||||||
gid = get_shared_group_gid()
|
|
||||||
if gid is None:
|
|
||||||
return
|
|
||||||
try:
|
|
||||||
if path.exists() and path.stat().st_gid != gid:
|
|
||||||
os.chown(path, -1, gid)
|
|
||||||
logger.debug(f"Set shared group ownership (gid {gid}) on {path}")
|
|
||||||
except OSError as e:
|
|
||||||
logger.debug(f"Could not set shared group ownership on {path}: {e}")
|
|
||||||
|
|
||||||
|
|
||||||
def get_config_file_mode(file_path: Path) -> int:
|
def get_config_file_mode(file_path: Path) -> int:
|
||||||
"""
|
"""
|
||||||
Return appropriate permission mode for config files.
|
Return appropriate permission mode for config files.
|
||||||
|
|||||||
+1
-25
@@ -38,7 +38,6 @@ from src.config_manager_atomic import (
|
|||||||
from src.common.permission_utils import (
|
from src.common.permission_utils import (
|
||||||
ensure_directory_permissions,
|
ensure_directory_permissions,
|
||||||
ensure_file_permissions,
|
ensure_file_permissions,
|
||||||
ensure_shared_group_ownership,
|
|
||||||
get_config_file_mode,
|
get_config_file_mode,
|
||||||
get_config_dir_mode
|
get_config_dir_mode
|
||||||
)
|
)
|
||||||
@@ -235,11 +234,6 @@ class ConfigManager:
|
|||||||
|
|
||||||
# Load and merge secrets if they exist (be permissive on errors)
|
# Load and merge secrets if they exist (be permissive on errors)
|
||||||
if os.path.exists(self.secrets_path):
|
if os.path.exists(self.secrets_path):
|
||||||
# Self-heal stale group ownership (e.g. the root-run display
|
|
||||||
# service wrote this file before the web user was granted
|
|
||||||
# group access) before every load attempt; no-op unless
|
|
||||||
# running as root and the group is already wrong.
|
|
||||||
ensure_shared_group_ownership(Path(self.secrets_path))
|
|
||||||
try:
|
try:
|
||||||
with open(self.secrets_path, 'r') as f:
|
with open(self.secrets_path, 'r') as f:
|
||||||
secrets = json.load(f)
|
secrets = json.load(f)
|
||||||
@@ -369,7 +363,6 @@ class ConfigManager:
|
|||||||
# Set proper file permissions after creation
|
# Set proper file permissions after creation
|
||||||
config_path_obj = Path(self.config_path)
|
config_path_obj = Path(self.config_path)
|
||||||
ensure_file_permissions(config_path_obj, get_config_file_mode(config_path_obj))
|
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)}")
|
||||||
|
|
||||||
@@ -482,11 +475,6 @@ class ConfigManager:
|
|||||||
self.logger.error(error_msg)
|
self.logger.error(error_msg)
|
||||||
raise ConfigError(error_msg, config_path=path_to_load)
|
raise ConfigError(error_msg, config_path=path_to_load)
|
||||||
|
|
||||||
if file_type == "secrets":
|
|
||||||
# Best-effort self-heal: no-op unless running as root and the
|
|
||||||
# group is stale (see load_config for why this can happen).
|
|
||||||
ensure_shared_group_ownership(Path(path_to_load))
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
with open(path_to_load, 'r') as f:
|
with open(path_to_load, 'r') as f:
|
||||||
return json.load(f)
|
return json.load(f)
|
||||||
@@ -494,18 +482,7 @@ class ConfigManager:
|
|||||||
error_msg = f"Error parsing {file_type} configuration file: {path_to_load}"
|
error_msg = f"Error parsing {file_type} configuration file: {path_to_load}"
|
||||||
self.logger.error(error_msg, exc_info=True)
|
self.logger.error(error_msg, exc_info=True)
|
||||||
raise ConfigError(error_msg, config_path=path_to_load) from e
|
raise ConfigError(error_msg, config_path=path_to_load) from e
|
||||||
except PermissionError as e:
|
except (IOError, OSError, PermissionError) as e:
|
||||||
if file_type == "secrets":
|
|
||||||
# Match load_config()'s tolerance: a secrets file the web
|
|
||||||
# process can't read (e.g. written 0640 by the root-run
|
|
||||||
# display service before the group was fixed up) shouldn't
|
|
||||||
# 500 the settings page — degrade to "no secrets" instead.
|
|
||||||
self.logger.warning(f"Secrets file not readable ({path_to_load}): {e}. Returning empty secrets.")
|
|
||||||
return {}
|
|
||||||
error_msg = f"Error loading {file_type} configuration file {path_to_load}: {str(e)}"
|
|
||||||
self.logger.error(error_msg, exc_info=True)
|
|
||||||
raise ConfigError(error_msg, config_path=path_to_load) from e
|
|
||||||
except (IOError, OSError) as e:
|
|
||||||
error_msg = f"Error loading {file_type} configuration file {path_to_load}: {str(e)}"
|
error_msg = f"Error loading {file_type} configuration file {path_to_load}: {str(e)}"
|
||||||
self.logger.error(error_msg, exc_info=True)
|
self.logger.error(error_msg, exc_info=True)
|
||||||
raise ConfigError(error_msg, config_path=path_to_load) from e
|
raise ConfigError(error_msg, config_path=path_to_load) from e
|
||||||
@@ -562,7 +539,6 @@ class ConfigManager:
|
|||||||
# Ensure final file has correct permissions
|
# Ensure final file has correct permissions
|
||||||
try:
|
try:
|
||||||
ensure_file_permissions(path_obj, file_mode)
|
ensure_file_permissions(path_obj, file_mode)
|
||||||
ensure_shared_group_ownership(path_obj)
|
|
||||||
except OSError as perm_error:
|
except OSError as perm_error:
|
||||||
# If we can't set permissions but file was written, log warning but don't fail
|
# If we can't set permissions but file was written, log warning but don't fail
|
||||||
self.logger.warning(
|
self.logger.warning(
|
||||||
|
|||||||
@@ -17,7 +17,6 @@ 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
|
|
||||||
|
|
||||||
|
|
||||||
class SaveResultStatus(Enum):
|
class SaveResultStatus(Enum):
|
||||||
@@ -411,13 +410,6 @@ class AtomicConfigManager:
|
|||||||
# This is important because temp files may have different permissions
|
# This is important because temp files may have different permissions
|
||||||
# and we need root service to be able to read config.json
|
# and we need root service to be able to read config.json
|
||||||
os.chmod(destination, target_mode)
|
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:
|
except Exception as e:
|
||||||
raise ConfigError(f"Error during atomic move: {e}") from e
|
raise ConfigError(f"Error during atomic move: {e}") from e
|
||||||
|
|||||||
@@ -0,0 +1,135 @@
|
|||||||
|
import os
|
||||||
|
import freetype
|
||||||
|
from PIL import ImageDraw, ImageFont
|
||||||
|
import logging
|
||||||
|
from typing import Dict, Any
|
||||||
|
from src.display_manager import DisplayManager
|
||||||
|
|
||||||
|
# Configure logging
|
||||||
|
logging.basicConfig(level=logging.INFO)
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
class FontTestManager:
|
||||||
|
"""Manager for testing fonts with easy BDF/TTF switching."""
|
||||||
|
|
||||||
|
def __init__(self, config: Dict[str, Any], display_manager: DisplayManager):
|
||||||
|
self.display_manager = display_manager
|
||||||
|
self.config = config
|
||||||
|
self.logger = logging.getLogger('FontTest')
|
||||||
|
|
||||||
|
# FONT CONFIGURATION - EASY SWITCHING
|
||||||
|
# Set to 'bdf' or 'ttf' to switch font types
|
||||||
|
self.font_type = 'bdf' # Change this to 'ttf' to use TTF font
|
||||||
|
|
||||||
|
# Font configurations
|
||||||
|
self.font_configs = {
|
||||||
|
'bdf': {
|
||||||
|
'path': "assets/fonts/cozette.bdf",
|
||||||
|
'display_name': "Cozette BTF",
|
||||||
|
'description': "BTF font Test"
|
||||||
|
},
|
||||||
|
'ttf': {
|
||||||
|
'path': "assets/fonts/5by7.regular.ttf",
|
||||||
|
'display_name': "5by7 TTF",
|
||||||
|
'description': "TTF font test"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Get current font configuration
|
||||||
|
self.current_config = self.font_configs[self.font_type]
|
||||||
|
self.font_path = self.current_config['path']
|
||||||
|
|
||||||
|
# Verify font exists
|
||||||
|
if not os.path.exists(self.font_path):
|
||||||
|
self.logger.error(f"Font file not found: {self.font_path}")
|
||||||
|
raise FileNotFoundError(f"Font file not found: {self.font_path}")
|
||||||
|
|
||||||
|
# Load the font based on type
|
||||||
|
if self.font_type == 'bdf':
|
||||||
|
self._load_bdf_font()
|
||||||
|
else:
|
||||||
|
self._load_ttf_font()
|
||||||
|
|
||||||
|
self.logger.info(f"Initialized FontTestManager with {self.current_config['description']}")
|
||||||
|
|
||||||
|
def _load_bdf_font(self):
|
||||||
|
"""Load BDF font using freetype."""
|
||||||
|
try:
|
||||||
|
self.face = freetype.Face(self.font_path)
|
||||||
|
self.logger.info(f"Successfully loaded BDF font from {self.font_path}")
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(f"Failed to load BDF font: {e}")
|
||||||
|
raise
|
||||||
|
|
||||||
|
def _load_ttf_font(self):
|
||||||
|
"""Load TTF font using PIL."""
|
||||||
|
try:
|
||||||
|
self.font = ImageFont.truetype(self.font_path, 8) # Size 8 for 5x7 font
|
||||||
|
self.logger.info(f"Successfully loaded TTF font from {self.font_path}")
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(f"Failed to load TTF font: {e}")
|
||||||
|
raise
|
||||||
|
|
||||||
|
def update(self):
|
||||||
|
"""No update needed for static display."""
|
||||||
|
|
||||||
|
def display(self, force_clear: bool = False):
|
||||||
|
"""Display the font with sample text."""
|
||||||
|
try:
|
||||||
|
# Clear the display
|
||||||
|
self.display_manager.clear()
|
||||||
|
|
||||||
|
# Draw font name at the top
|
||||||
|
self.display_manager.draw_text(self.current_config['display_name'], y=2, color=(255, 255, 255))
|
||||||
|
|
||||||
|
# Draw sample text
|
||||||
|
draw = ImageDraw.Draw(self.display_manager.image)
|
||||||
|
sample_text = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
|
||||||
|
|
||||||
|
# Calculate starting position
|
||||||
|
x = 10 # Start 10 pixels from the left
|
||||||
|
y = 10 # Start 10 pixels from the top
|
||||||
|
|
||||||
|
# Draw text based on font type
|
||||||
|
if self.font_type == 'bdf':
|
||||||
|
self._draw_bdf_text(draw, sample_text, x, y)
|
||||||
|
else:
|
||||||
|
self._draw_ttf_text(draw, sample_text, x, y)
|
||||||
|
|
||||||
|
# Update the display once
|
||||||
|
self.display_manager.update_display()
|
||||||
|
|
||||||
|
# Log that display is complete
|
||||||
|
self.logger.info("Font test display complete.")
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
self.logger.error(f"Error displaying font test: {e}", exc_info=True)
|
||||||
|
|
||||||
|
def _draw_bdf_text(self, draw, text, x, y):
|
||||||
|
"""Draw text using BDF font."""
|
||||||
|
for char in text:
|
||||||
|
# Load the glyph
|
||||||
|
self.face.load_char(char)
|
||||||
|
bitmap = self.face.glyph.bitmap
|
||||||
|
|
||||||
|
# Draw the glyph
|
||||||
|
for i in range(bitmap.rows):
|
||||||
|
for j in range(bitmap.width):
|
||||||
|
try:
|
||||||
|
# Get the byte containing the pixel
|
||||||
|
byte_index = i * bitmap.pitch + (j // 8)
|
||||||
|
if byte_index < len(bitmap.buffer):
|
||||||
|
byte = bitmap.buffer[byte_index]
|
||||||
|
# Check if the specific bit is set
|
||||||
|
if byte & (1 << (7 - (j % 8))):
|
||||||
|
draw.point((x + j, y + i), fill=(255, 255, 255))
|
||||||
|
except IndexError:
|
||||||
|
self.logger.warning(f"Index out of range for char '{char}' at position ({i}, {j})")
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Move to next character position
|
||||||
|
x += self.face.glyph.advance.x >> 6
|
||||||
|
|
||||||
|
def _draw_ttf_text(self, draw, text, x, y):
|
||||||
|
"""Draw text using TTF font."""
|
||||||
|
draw.text((x, y), text, font=self.font, fill=(255, 255, 255))
|
||||||
@@ -0,0 +1,150 @@
|
|||||||
|
"""
|
||||||
|
Generic Cache Mixin for Any Manager
|
||||||
|
|
||||||
|
This mixin provides caching functionality that can be used by any manager
|
||||||
|
that needs to cache data, not just sports managers. It's a more general
|
||||||
|
version of BackgroundCacheMixin that works for weather, stocks, news, etc.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import time
|
||||||
|
from typing import Dict, Optional, Any, Callable
|
||||||
|
|
||||||
|
|
||||||
|
class GenericCacheMixin:
|
||||||
|
"""
|
||||||
|
Generic mixin class that provides caching functionality to any manager.
|
||||||
|
|
||||||
|
This mixin can be used by weather, stock, news, or any other manager
|
||||||
|
that needs to cache data with performance monitoring.
|
||||||
|
|
||||||
|
Note: For sports managers that need background service cache integration,
|
||||||
|
use BackgroundCacheMixin instead. See src/background_cache_mixin.py for details.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def _fetch_data_with_cache(self,
|
||||||
|
cache_key: str,
|
||||||
|
api_fetch_method: Callable,
|
||||||
|
cache_ttl: int = 300,
|
||||||
|
force_refresh: bool = False) -> Optional[Dict]:
|
||||||
|
"""
|
||||||
|
Generic caching pattern for any manager.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
cache_key: Unique cache key for this data
|
||||||
|
api_fetch_method: Method to call for fresh data
|
||||||
|
cache_ttl: Time-to-live in seconds (default: 5 minutes)
|
||||||
|
force_refresh: Skip cache and fetch fresh data
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Cached or fresh data from API
|
||||||
|
"""
|
||||||
|
start_time = time.time()
|
||||||
|
cache_hit = False
|
||||||
|
cache_source = None
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Check cache first (unless forcing refresh)
|
||||||
|
if not force_refresh:
|
||||||
|
cached_data = self.cache_manager.get_cached_data(cache_key, cache_ttl)
|
||||||
|
if cached_data:
|
||||||
|
self.logger.info(f"Using cached data for {cache_key}")
|
||||||
|
cache_hit = True
|
||||||
|
cache_source = "cache"
|
||||||
|
self.cache_manager.record_cache_hit('regular')
|
||||||
|
|
||||||
|
# Record performance metrics
|
||||||
|
duration = time.time() - start_time
|
||||||
|
self.cache_manager.record_fetch_time(duration)
|
||||||
|
self._log_fetch_performance(cache_key, duration, cache_hit, cache_source)
|
||||||
|
|
||||||
|
return cached_data
|
||||||
|
|
||||||
|
# Fetch fresh data
|
||||||
|
self.logger.info(f"Fetching fresh data for {cache_key}")
|
||||||
|
result = api_fetch_method()
|
||||||
|
cache_source = "api_fresh"
|
||||||
|
|
||||||
|
# Store in cache if we got data
|
||||||
|
if result:
|
||||||
|
self.cache_manager.save_cache(cache_key, result)
|
||||||
|
self.cache_manager.record_cache_miss('regular')
|
||||||
|
else:
|
||||||
|
self.logger.warning(f"No data returned for {cache_key}")
|
||||||
|
|
||||||
|
# Record performance metrics
|
||||||
|
duration = time.time() - start_time
|
||||||
|
self.cache_manager.record_fetch_time(duration)
|
||||||
|
|
||||||
|
# Log performance
|
||||||
|
self._log_fetch_performance(cache_key, duration, cache_hit, cache_source)
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
duration = time.time() - start_time
|
||||||
|
self.logger.error(f"Error fetching data for {cache_key} after {duration:.2f}s: {e}")
|
||||||
|
self.cache_manager.record_fetch_time(duration)
|
||||||
|
raise
|
||||||
|
|
||||||
|
def _log_fetch_performance(self, cache_key: str, duration: float, cache_hit: bool, cache_source: str):
|
||||||
|
"""
|
||||||
|
Log detailed performance metrics for fetch operations.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
cache_key: Cache key that was accessed
|
||||||
|
duration: Fetch operation duration in seconds
|
||||||
|
cache_hit: Whether this was a cache hit
|
||||||
|
cache_source: Source of the data (cache, api_fresh, etc.)
|
||||||
|
"""
|
||||||
|
# Log basic performance info
|
||||||
|
self.logger.info(f"Fetch completed for {cache_key} in {duration:.2f}s "
|
||||||
|
f"(cache_hit={cache_hit}, source={cache_source})")
|
||||||
|
|
||||||
|
# Log detailed metrics every 10 operations
|
||||||
|
if hasattr(self, '_fetch_count'):
|
||||||
|
self._fetch_count += 1
|
||||||
|
else:
|
||||||
|
self._fetch_count = 1
|
||||||
|
|
||||||
|
if self._fetch_count % 10 == 0:
|
||||||
|
metrics = self.cache_manager.get_cache_metrics()
|
||||||
|
self.logger.info(f"Cache Performance Summary - "
|
||||||
|
f"Hit Rate: {metrics['cache_hit_rate']:.2%}, "
|
||||||
|
f"API Calls Saved: {metrics['api_calls_saved']}, "
|
||||||
|
f"Avg Fetch Time: {metrics['average_fetch_time']:.2f}s")
|
||||||
|
|
||||||
|
def get_cache_performance_summary(self) -> Dict[str, Any]:
|
||||||
|
"""
|
||||||
|
Get cache performance summary for this manager.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Dictionary containing cache performance metrics
|
||||||
|
"""
|
||||||
|
return self.cache_manager.get_cache_metrics()
|
||||||
|
|
||||||
|
def log_cache_performance(self):
|
||||||
|
"""Log current cache performance metrics."""
|
||||||
|
self.cache_manager.log_cache_metrics()
|
||||||
|
|
||||||
|
def clear_cache_for_key(self, cache_key: str):
|
||||||
|
"""Clear cache for a specific key."""
|
||||||
|
self.cache_manager.clear_cache(cache_key)
|
||||||
|
self.logger.info(f"Cleared cache for {cache_key}")
|
||||||
|
|
||||||
|
def get_cache_info(self, cache_key: str) -> Dict[str, Any]:
|
||||||
|
"""
|
||||||
|
Get information about a cached item.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
cache_key: Cache key to check
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Dictionary with cache information
|
||||||
|
"""
|
||||||
|
# This would need to be implemented in CacheManager
|
||||||
|
# For now, just return basic info
|
||||||
|
return {
|
||||||
|
'key': cache_key,
|
||||||
|
'exists': self.cache_manager.get_cached_data(cache_key, 0) is not None,
|
||||||
|
'ttl': 'unknown' # Would need to be implemented
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
"""Deprecated: use src/adaptive_images.py (fit_image) instead.
|
||||||
|
|
||||||
|
This module predates the adaptive image system and has no known callers.
|
||||||
|
It is kept only so any out-of-tree code importing it keeps working.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from PIL import Image
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
def scale_to_max_dimensions(img, max_width, max_height):
|
||||||
|
h_to_w_ratio = img.height / img.width
|
||||||
|
w_to_h_ratio = img.width / img.height
|
||||||
|
|
||||||
|
if img.height > max_height:
|
||||||
|
img = img.resize((int(max_height * w_to_h_ratio), max_height), Image.Resampling.LANCZOS)
|
||||||
|
|
||||||
|
if img.width > max_width:
|
||||||
|
img = img.resize((max_width, int(max_width * h_to_w_ratio)), Image.Resampling.LANCZOS)
|
||||||
|
|
||||||
|
return img
|
||||||
@@ -0,0 +1,409 @@
|
|||||||
|
"""
|
||||||
|
Layout Manager for LED Matrix Display
|
||||||
|
Handles custom layouts, element positioning, and display composition.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import logging
|
||||||
|
from typing import Dict, List, Any
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
class LayoutManager:
|
||||||
|
def __init__(self, display_manager=None, config_path="config/custom_layouts.json"):
|
||||||
|
self.display_manager = display_manager
|
||||||
|
self.config_path = config_path
|
||||||
|
self.layouts = self.load_layouts()
|
||||||
|
self.current_layout = None
|
||||||
|
|
||||||
|
def load_layouts(self) -> Dict[str, Any]:
|
||||||
|
"""Load saved layouts from file."""
|
||||||
|
try:
|
||||||
|
if os.path.exists(self.config_path):
|
||||||
|
with open(self.config_path, 'r') as f:
|
||||||
|
return json.load(f)
|
||||||
|
return {}
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Error loading layouts: {e}")
|
||||||
|
return {}
|
||||||
|
|
||||||
|
def save_layouts(self) -> bool:
|
||||||
|
"""Save layouts to file."""
|
||||||
|
try:
|
||||||
|
from pathlib import Path
|
||||||
|
from src.common.permission_utils import (
|
||||||
|
ensure_directory_permissions,
|
||||||
|
get_config_dir_mode
|
||||||
|
)
|
||||||
|
config_path_obj = Path(self.config_path)
|
||||||
|
ensure_directory_permissions(config_path_obj.parent, get_config_dir_mode())
|
||||||
|
with open(self.config_path, 'w') as f:
|
||||||
|
json.dump(self.layouts, f, indent=2)
|
||||||
|
return True
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Error saving layouts: {e}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
def create_layout(self, name: str, elements: List[Dict], description: str = "") -> bool:
|
||||||
|
"""Create a new layout."""
|
||||||
|
try:
|
||||||
|
self.layouts[name] = {
|
||||||
|
'elements': elements,
|
||||||
|
'description': description,
|
||||||
|
'created': datetime.now().isoformat(),
|
||||||
|
'modified': datetime.now().isoformat()
|
||||||
|
}
|
||||||
|
return self.save_layouts()
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Error creating layout '{name}': {e}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
def update_layout(self, name: str, elements: List[Dict], description: str = None) -> bool:
|
||||||
|
"""Update an existing layout."""
|
||||||
|
try:
|
||||||
|
if name not in self.layouts:
|
||||||
|
return False
|
||||||
|
|
||||||
|
self.layouts[name]['elements'] = elements
|
||||||
|
self.layouts[name]['modified'] = datetime.now().isoformat()
|
||||||
|
|
||||||
|
if description is not None:
|
||||||
|
self.layouts[name]['description'] = description
|
||||||
|
|
||||||
|
return self.save_layouts()
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Error updating layout '{name}': {e}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
def delete_layout(self, name: str) -> bool:
|
||||||
|
"""Delete a layout."""
|
||||||
|
try:
|
||||||
|
if name in self.layouts:
|
||||||
|
del self.layouts[name]
|
||||||
|
return self.save_layouts()
|
||||||
|
return False
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Error deleting layout '{name}': {e}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
def get_layout(self, name: str) -> Dict[str, Any]:
|
||||||
|
"""Get a specific layout."""
|
||||||
|
return self.layouts.get(name, {})
|
||||||
|
|
||||||
|
def list_layouts(self) -> List[str]:
|
||||||
|
"""Get list of all layout names."""
|
||||||
|
return list(self.layouts.keys())
|
||||||
|
|
||||||
|
def set_current_layout(self, name: str) -> bool:
|
||||||
|
"""Set the current active layout."""
|
||||||
|
if name in self.layouts:
|
||||||
|
self.current_layout = name
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def render_layout(self, layout_name: str = None, data_context: Dict = None) -> bool:
|
||||||
|
"""Render a layout to the display."""
|
||||||
|
if not self.display_manager:
|
||||||
|
logger.error("No display manager available")
|
||||||
|
return False
|
||||||
|
|
||||||
|
layout_name = layout_name or self.current_layout
|
||||||
|
if not layout_name or layout_name not in self.layouts:
|
||||||
|
logger.error(f"Layout '{layout_name}' not found")
|
||||||
|
return False
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Clear the display
|
||||||
|
self.display_manager.clear()
|
||||||
|
|
||||||
|
# Get layout elements
|
||||||
|
elements = self.layouts[layout_name]['elements']
|
||||||
|
|
||||||
|
# Render each element
|
||||||
|
for element in elements:
|
||||||
|
self.render_element(element, data_context or {})
|
||||||
|
|
||||||
|
# Update the display
|
||||||
|
self.display_manager.update_display()
|
||||||
|
return True
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Error rendering layout '{layout_name}': {e}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
def render_element(self, element: Dict, data_context: Dict) -> None:
|
||||||
|
"""Render a single element."""
|
||||||
|
element_type = element.get('type')
|
||||||
|
x = element.get('x', 0)
|
||||||
|
y = element.get('y', 0)
|
||||||
|
properties = element.get('properties', {})
|
||||||
|
|
||||||
|
try:
|
||||||
|
if element_type == 'text':
|
||||||
|
self._render_text_element(x, y, properties, data_context)
|
||||||
|
elif element_type == 'weather_icon':
|
||||||
|
self._render_weather_icon_element(x, y, properties, data_context)
|
||||||
|
elif element_type == 'rectangle':
|
||||||
|
self._render_rectangle_element(x, y, properties)
|
||||||
|
elif element_type == 'line':
|
||||||
|
self._render_line_element(x, y, properties)
|
||||||
|
elif element_type == 'clock':
|
||||||
|
self._render_clock_element(x, y, properties)
|
||||||
|
elif element_type == 'data_text':
|
||||||
|
self._render_data_text_element(x, y, properties, data_context)
|
||||||
|
else:
|
||||||
|
logger.warning(f"Unknown element type: {element_type}")
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Error rendering element {element_type}: {e}")
|
||||||
|
|
||||||
|
def _render_text_element(self, x: int, y: int, properties: Dict, data_context: Dict) -> None:
|
||||||
|
"""Render a text element."""
|
||||||
|
text = properties.get('text', 'Sample Text')
|
||||||
|
color = tuple(properties.get('color', [255, 255, 255]))
|
||||||
|
font_size = properties.get('font_size', 'normal')
|
||||||
|
|
||||||
|
# Support template variables in text
|
||||||
|
text = self._process_template_text(text, data_context)
|
||||||
|
|
||||||
|
# Select font
|
||||||
|
if font_size == 'small':
|
||||||
|
font = self.display_manager.small_font
|
||||||
|
elif font_size == 'large':
|
||||||
|
font = self.display_manager.regular_font
|
||||||
|
else:
|
||||||
|
font = self.display_manager.regular_font
|
||||||
|
|
||||||
|
self.display_manager.draw_text(text, x, y, color, font=font)
|
||||||
|
|
||||||
|
def _render_weather_icon_element(self, x: int, y: int, properties: Dict, data_context: Dict) -> None:
|
||||||
|
"""Render a weather icon element."""
|
||||||
|
condition = properties.get('condition', 'sunny')
|
||||||
|
size = properties.get('size', 16)
|
||||||
|
|
||||||
|
# Use weather data from context if available
|
||||||
|
if 'weather' in data_context and 'condition' in data_context['weather']:
|
||||||
|
condition = data_context['weather']['condition'].lower()
|
||||||
|
|
||||||
|
self.display_manager.draw_weather_icon(condition, x, y, size)
|
||||||
|
|
||||||
|
def _render_rectangle_element(self, x: int, y: int, properties: Dict) -> None:
|
||||||
|
"""Render a rectangle element."""
|
||||||
|
width = properties.get('width', 10)
|
||||||
|
height = properties.get('height', 10)
|
||||||
|
color = tuple(properties.get('color', [255, 255, 255]))
|
||||||
|
filled = properties.get('filled', False)
|
||||||
|
|
||||||
|
if filled:
|
||||||
|
self.display_manager.draw.rectangle(
|
||||||
|
[x, y, x + width, y + height],
|
||||||
|
fill=color
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
self.display_manager.draw.rectangle(
|
||||||
|
[x, y, x + width, y + height],
|
||||||
|
outline=color
|
||||||
|
)
|
||||||
|
|
||||||
|
def _render_line_element(self, x: int, y: int, properties: Dict) -> None:
|
||||||
|
"""Render a line element."""
|
||||||
|
x2 = properties.get('x2', x + 10)
|
||||||
|
y2 = properties.get('y2', y)
|
||||||
|
color = tuple(properties.get('color', [255, 255, 255]))
|
||||||
|
width = properties.get('width', 1)
|
||||||
|
|
||||||
|
self.display_manager.draw.line([x, y, x2, y2], fill=color, width=width)
|
||||||
|
|
||||||
|
def _render_clock_element(self, x: int, y: int, properties: Dict) -> None:
|
||||||
|
"""Render a clock element."""
|
||||||
|
format_str = properties.get('format', '%H:%M')
|
||||||
|
color = tuple(properties.get('color', [255, 255, 255]))
|
||||||
|
|
||||||
|
current_time = datetime.now().strftime(format_str)
|
||||||
|
self.display_manager.draw_text(current_time, x, y, color)
|
||||||
|
|
||||||
|
def _render_data_text_element(self, x: int, y: int, properties: Dict, data_context: Dict) -> None:
|
||||||
|
"""Render a data-driven text element."""
|
||||||
|
data_key = properties.get('data_key', '')
|
||||||
|
format_str = properties.get('format', '{value}')
|
||||||
|
color = tuple(properties.get('color', [255, 255, 255]))
|
||||||
|
default_value = properties.get('default', 'N/A')
|
||||||
|
|
||||||
|
# Extract data from context
|
||||||
|
value = self._get_nested_value(data_context, data_key, default_value)
|
||||||
|
|
||||||
|
# Format the text
|
||||||
|
try:
|
||||||
|
text = format_str.format(value=value)
|
||||||
|
except (ValueError, TypeError, KeyError, IndexError):
|
||||||
|
text = str(value)
|
||||||
|
|
||||||
|
self.display_manager.draw_text(text, x, y, color)
|
||||||
|
|
||||||
|
def _process_template_text(self, text: str, data_context: Dict) -> str:
|
||||||
|
"""Process template variables in text."""
|
||||||
|
try:
|
||||||
|
# Simple template processing - replace {key} with values from context
|
||||||
|
for key, value in data_context.items():
|
||||||
|
placeholder = f"{{{key}}}"
|
||||||
|
if placeholder in text:
|
||||||
|
text = text.replace(placeholder, str(value))
|
||||||
|
return text
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Error processing template text: {e}")
|
||||||
|
return text
|
||||||
|
|
||||||
|
def _get_nested_value(self, data: Dict, key: str, default=None):
|
||||||
|
"""Get a nested value from a dictionary using dot notation."""
|
||||||
|
try:
|
||||||
|
keys = key.split('.')
|
||||||
|
value = data
|
||||||
|
for k in keys:
|
||||||
|
value = value[k]
|
||||||
|
return value
|
||||||
|
except (KeyError, TypeError):
|
||||||
|
return default
|
||||||
|
|
||||||
|
def create_preset_layouts(self) -> None:
|
||||||
|
"""Create some preset layouts for common use cases."""
|
||||||
|
# Basic clock layout
|
||||||
|
clock_layout = [
|
||||||
|
{
|
||||||
|
'type': 'clock',
|
||||||
|
'x': 10,
|
||||||
|
'y': 10,
|
||||||
|
'properties': {
|
||||||
|
'format': '%H:%M',
|
||||||
|
'color': [255, 255, 255]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'type': 'clock',
|
||||||
|
'x': 10,
|
||||||
|
'y': 20,
|
||||||
|
'properties': {
|
||||||
|
'format': '%m/%d',
|
||||||
|
'color': [100, 100, 255]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
self.create_layout('basic_clock', clock_layout, 'Simple clock with date')
|
||||||
|
|
||||||
|
# Weather layout
|
||||||
|
weather_layout = [
|
||||||
|
{
|
||||||
|
'type': 'weather_icon',
|
||||||
|
'x': 5,
|
||||||
|
'y': 5,
|
||||||
|
'properties': {
|
||||||
|
'condition': 'sunny',
|
||||||
|
'size': 20
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'type': 'data_text',
|
||||||
|
'x': 30,
|
||||||
|
'y': 8,
|
||||||
|
'properties': {
|
||||||
|
'data_key': 'weather.temperature',
|
||||||
|
'format': '{value}°',
|
||||||
|
'color': [255, 200, 0],
|
||||||
|
'default': '--°'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'type': 'data_text',
|
||||||
|
'x': 30,
|
||||||
|
'y': 18,
|
||||||
|
'properties': {
|
||||||
|
'data_key': 'weather.condition',
|
||||||
|
'format': '{value}',
|
||||||
|
'color': [200, 200, 200],
|
||||||
|
'default': 'Unknown'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
self.create_layout('weather_display', weather_layout, 'Weather icon with temperature and condition')
|
||||||
|
|
||||||
|
# Mixed dashboard layout
|
||||||
|
dashboard_layout = [
|
||||||
|
{
|
||||||
|
'type': 'clock',
|
||||||
|
'x': 2,
|
||||||
|
'y': 2,
|
||||||
|
'properties': {
|
||||||
|
'format': '%H:%M',
|
||||||
|
'color': [255, 255, 255]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'type': 'weather_icon',
|
||||||
|
'x': 50,
|
||||||
|
'y': 2,
|
||||||
|
'properties': {
|
||||||
|
'size': 16
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'type': 'data_text',
|
||||||
|
'x': 70,
|
||||||
|
'y': 5,
|
||||||
|
'properties': {
|
||||||
|
'data_key': 'weather.temperature',
|
||||||
|
'format': '{value}°',
|
||||||
|
'color': [255, 200, 0],
|
||||||
|
'default': '--°'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'type': 'line',
|
||||||
|
'x': 0,
|
||||||
|
'y': 15,
|
||||||
|
'properties': {
|
||||||
|
'x2': 128,
|
||||||
|
'y2': 15,
|
||||||
|
'color': [100, 100, 100]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'type': 'data_text',
|
||||||
|
'x': 2,
|
||||||
|
'y': 18,
|
||||||
|
'properties': {
|
||||||
|
'data_key': 'stocks.AAPL.price',
|
||||||
|
'format': 'AAPL: ${value}',
|
||||||
|
'color': [0, 255, 0],
|
||||||
|
'default': 'AAPL: N/A'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
self.create_layout('dashboard', dashboard_layout, 'Mixed dashboard with clock, weather, and stocks')
|
||||||
|
|
||||||
|
logger.info("Created preset layouts")
|
||||||
|
|
||||||
|
def get_layout_preview(self, layout_name: str) -> Dict[str, Any]:
|
||||||
|
"""Get a preview representation of a layout."""
|
||||||
|
if layout_name not in self.layouts:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
layout = self.layouts[layout_name]
|
||||||
|
elements = layout['elements']
|
||||||
|
|
||||||
|
# Create a simple preview representation
|
||||||
|
preview = {
|
||||||
|
'name': layout_name,
|
||||||
|
'description': layout.get('description', ''),
|
||||||
|
'element_count': len(elements),
|
||||||
|
'elements': []
|
||||||
|
}
|
||||||
|
|
||||||
|
for element in elements:
|
||||||
|
preview['elements'].append({
|
||||||
|
'type': element.get('type'),
|
||||||
|
'position': f"({element.get('x', 0)}, {element.get('y', 0)})",
|
||||||
|
'properties': list(element.get('properties', {}).keys())
|
||||||
|
})
|
||||||
|
|
||||||
|
return preview
|
||||||
@@ -0,0 +1,392 @@
|
|||||||
|
"""
|
||||||
|
Tests for LayoutManager.
|
||||||
|
|
||||||
|
Tests layout creation, management, rendering, and element positioning.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
import json
|
||||||
|
from unittest.mock import MagicMock
|
||||||
|
from src.layout_manager import LayoutManager
|
||||||
|
|
||||||
|
|
||||||
|
class TestLayoutManager:
|
||||||
|
"""Test LayoutManager functionality."""
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def tmp_layout_file(self, tmp_path):
|
||||||
|
"""Create a temporary layout file."""
|
||||||
|
layout_file = tmp_path / "custom_layouts.json"
|
||||||
|
return str(layout_file)
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_display_manager(self):
|
||||||
|
"""Create a mock display manager."""
|
||||||
|
dm = MagicMock()
|
||||||
|
dm.clear = MagicMock()
|
||||||
|
dm.update_display = MagicMock()
|
||||||
|
dm.draw_text = MagicMock()
|
||||||
|
dm.draw_weather_icon = MagicMock()
|
||||||
|
dm.small_font = MagicMock()
|
||||||
|
dm.regular_font = MagicMock()
|
||||||
|
return dm
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def layout_manager(self, tmp_layout_file, mock_display_manager):
|
||||||
|
"""Create a LayoutManager instance."""
|
||||||
|
return LayoutManager(
|
||||||
|
display_manager=mock_display_manager,
|
||||||
|
config_path=tmp_layout_file
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_init(self, tmp_layout_file, mock_display_manager):
|
||||||
|
"""Test LayoutManager initialization."""
|
||||||
|
lm = LayoutManager(
|
||||||
|
display_manager=mock_display_manager,
|
||||||
|
config_path=tmp_layout_file
|
||||||
|
)
|
||||||
|
|
||||||
|
assert lm.display_manager == mock_display_manager
|
||||||
|
assert lm.config_path == tmp_layout_file
|
||||||
|
assert lm.layouts == {}
|
||||||
|
assert lm.current_layout is None
|
||||||
|
|
||||||
|
def test_load_layouts_file_exists(self, tmp_path, mock_display_manager):
|
||||||
|
"""Test loading layouts from existing file."""
|
||||||
|
layout_file = tmp_path / "custom_layouts.json"
|
||||||
|
layout_data = {
|
||||||
|
"test_layout": {
|
||||||
|
"elements": [{"type": "text", "x": 0, "y": 0}],
|
||||||
|
"description": "Test layout"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
with open(layout_file, 'w') as f:
|
||||||
|
json.dump(layout_data, f)
|
||||||
|
|
||||||
|
lm = LayoutManager(
|
||||||
|
display_manager=mock_display_manager,
|
||||||
|
config_path=str(layout_file)
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "test_layout" in lm.layouts
|
||||||
|
assert lm.layouts["test_layout"]["description"] == "Test layout"
|
||||||
|
|
||||||
|
def test_load_layouts_file_not_exists(self, tmp_layout_file, mock_display_manager):
|
||||||
|
"""Test loading layouts when file doesn't exist."""
|
||||||
|
lm = LayoutManager(
|
||||||
|
display_manager=mock_display_manager,
|
||||||
|
config_path=tmp_layout_file
|
||||||
|
)
|
||||||
|
|
||||||
|
assert lm.layouts == {}
|
||||||
|
|
||||||
|
def test_create_layout(self, layout_manager):
|
||||||
|
"""Test creating a new layout."""
|
||||||
|
elements = [{"type": "text", "x": 10, "y": 20, "properties": {"text": "Hello"}}]
|
||||||
|
|
||||||
|
result = layout_manager.create_layout("test_layout", elements, "Test description")
|
||||||
|
|
||||||
|
assert result is True
|
||||||
|
assert "test_layout" in layout_manager.layouts
|
||||||
|
assert layout_manager.layouts["test_layout"]["elements"] == elements
|
||||||
|
assert layout_manager.layouts["test_layout"]["description"] == "Test description"
|
||||||
|
assert "created" in layout_manager.layouts["test_layout"]
|
||||||
|
assert "modified" in layout_manager.layouts["test_layout"]
|
||||||
|
|
||||||
|
def test_update_layout(self, layout_manager):
|
||||||
|
"""Test updating an existing layout."""
|
||||||
|
# Create a layout first
|
||||||
|
elements1 = [{"type": "text", "x": 0, "y": 0}]
|
||||||
|
layout_manager.create_layout("test_layout", elements1, "Original")
|
||||||
|
|
||||||
|
# Update it
|
||||||
|
elements2 = [{"type": "text", "x": 10, "y": 20}]
|
||||||
|
result = layout_manager.update_layout("test_layout", elements2, "Updated")
|
||||||
|
|
||||||
|
assert result is True
|
||||||
|
assert layout_manager.layouts["test_layout"]["elements"] == elements2
|
||||||
|
assert layout_manager.layouts["test_layout"]["description"] == "Updated"
|
||||||
|
assert "modified" in layout_manager.layouts["test_layout"]
|
||||||
|
|
||||||
|
def test_update_layout_not_exists(self, layout_manager):
|
||||||
|
"""Test updating a non-existent layout."""
|
||||||
|
elements = [{"type": "text", "x": 0, "y": 0}]
|
||||||
|
result = layout_manager.update_layout("nonexistent", elements)
|
||||||
|
|
||||||
|
assert result is False
|
||||||
|
|
||||||
|
def test_delete_layout(self, layout_manager):
|
||||||
|
"""Test deleting a layout."""
|
||||||
|
elements = [{"type": "text", "x": 0, "y": 0}]
|
||||||
|
layout_manager.create_layout("test_layout", elements)
|
||||||
|
|
||||||
|
result = layout_manager.delete_layout("test_layout")
|
||||||
|
|
||||||
|
assert result is True
|
||||||
|
assert "test_layout" not in layout_manager.layouts
|
||||||
|
|
||||||
|
def test_delete_layout_not_exists(self, layout_manager):
|
||||||
|
"""Test deleting a non-existent layout."""
|
||||||
|
result = layout_manager.delete_layout("nonexistent")
|
||||||
|
|
||||||
|
assert result is False
|
||||||
|
|
||||||
|
def test_get_layout(self, layout_manager):
|
||||||
|
"""Test getting a specific layout."""
|
||||||
|
elements = [{"type": "text", "x": 0, "y": 0}]
|
||||||
|
layout_manager.create_layout("test_layout", elements)
|
||||||
|
|
||||||
|
layout = layout_manager.get_layout("test_layout")
|
||||||
|
|
||||||
|
assert layout is not None
|
||||||
|
assert layout["elements"] == elements
|
||||||
|
|
||||||
|
def test_get_layout_not_exists(self, layout_manager):
|
||||||
|
"""Test getting a non-existent layout."""
|
||||||
|
layout = layout_manager.get_layout("nonexistent")
|
||||||
|
|
||||||
|
assert layout == {}
|
||||||
|
|
||||||
|
def test_list_layouts(self, layout_manager):
|
||||||
|
"""Test listing all layouts."""
|
||||||
|
layout_manager.create_layout("layout1", [])
|
||||||
|
layout_manager.create_layout("layout2", [])
|
||||||
|
layout_manager.create_layout("layout3", [])
|
||||||
|
|
||||||
|
layouts = layout_manager.list_layouts()
|
||||||
|
|
||||||
|
assert len(layouts) == 3
|
||||||
|
assert "layout1" in layouts
|
||||||
|
assert "layout2" in layouts
|
||||||
|
assert "layout3" in layouts
|
||||||
|
|
||||||
|
def test_set_current_layout(self, layout_manager):
|
||||||
|
"""Test setting the current layout."""
|
||||||
|
layout_manager.create_layout("test_layout", [])
|
||||||
|
|
||||||
|
result = layout_manager.set_current_layout("test_layout")
|
||||||
|
|
||||||
|
assert result is True
|
||||||
|
assert layout_manager.current_layout == "test_layout"
|
||||||
|
|
||||||
|
def test_set_current_layout_not_exists(self, layout_manager):
|
||||||
|
"""Test setting a non-existent layout as current."""
|
||||||
|
result = layout_manager.set_current_layout("nonexistent")
|
||||||
|
|
||||||
|
assert result is False
|
||||||
|
assert layout_manager.current_layout is None
|
||||||
|
|
||||||
|
def test_render_layout(self, layout_manager, mock_display_manager):
|
||||||
|
"""Test rendering a layout."""
|
||||||
|
elements = [
|
||||||
|
{"type": "text", "x": 0, "y": 0, "properties": {"text": "Hello"}},
|
||||||
|
{"type": "text", "x": 10, "y": 10, "properties": {"text": "World"}}
|
||||||
|
]
|
||||||
|
layout_manager.create_layout("test_layout", elements)
|
||||||
|
|
||||||
|
result = layout_manager.render_layout("test_layout")
|
||||||
|
|
||||||
|
assert result is True
|
||||||
|
mock_display_manager.clear.assert_called_once()
|
||||||
|
mock_display_manager.update_display.assert_called_once()
|
||||||
|
assert mock_display_manager.draw_text.call_count == 2
|
||||||
|
|
||||||
|
def test_render_layout_no_display_manager(self, tmp_layout_file):
|
||||||
|
"""Test rendering without display manager."""
|
||||||
|
lm = LayoutManager(display_manager=None, config_path=tmp_layout_file)
|
||||||
|
lm.create_layout("test_layout", [])
|
||||||
|
|
||||||
|
result = lm.render_layout("test_layout")
|
||||||
|
|
||||||
|
assert result is False
|
||||||
|
|
||||||
|
def test_render_layout_not_exists(self, layout_manager):
|
||||||
|
"""Test rendering a non-existent layout."""
|
||||||
|
result = layout_manager.render_layout("nonexistent")
|
||||||
|
|
||||||
|
assert result is False
|
||||||
|
|
||||||
|
def test_render_element_text(self, layout_manager, mock_display_manager):
|
||||||
|
"""Test rendering a text element."""
|
||||||
|
element = {
|
||||||
|
"type": "text",
|
||||||
|
"x": 10,
|
||||||
|
"y": 20,
|
||||||
|
"properties": {
|
||||||
|
"text": "Hello",
|
||||||
|
"color": [255, 0, 0],
|
||||||
|
"font_size": "small"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
layout_manager.render_element(element, {})
|
||||||
|
|
||||||
|
mock_display_manager.draw_text.assert_called_once()
|
||||||
|
call_args = mock_display_manager.draw_text.call_args
|
||||||
|
assert call_args[0][0] == "Hello" # text
|
||||||
|
assert call_args[0][1] == 10 # x
|
||||||
|
assert call_args[0][2] == 20 # y
|
||||||
|
|
||||||
|
def test_render_element_weather_icon(self, layout_manager, mock_display_manager):
|
||||||
|
"""Test rendering a weather icon element."""
|
||||||
|
element = {
|
||||||
|
"type": "weather_icon",
|
||||||
|
"x": 10,
|
||||||
|
"y": 20,
|
||||||
|
"properties": {
|
||||||
|
"condition": "sunny",
|
||||||
|
"size": 16
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
layout_manager.render_element(element, {})
|
||||||
|
|
||||||
|
mock_display_manager.draw_weather_icon.assert_called_once_with("sunny", 10, 20, 16)
|
||||||
|
|
||||||
|
def test_render_element_weather_icon_from_context(self, layout_manager, mock_display_manager):
|
||||||
|
"""Test rendering weather icon with data from context."""
|
||||||
|
element = {
|
||||||
|
"type": "weather_icon",
|
||||||
|
"x": 10,
|
||||||
|
"y": 20,
|
||||||
|
"properties": {"size": 16}
|
||||||
|
}
|
||||||
|
data_context = {
|
||||||
|
"weather": {
|
||||||
|
"condition": "cloudy"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
layout_manager.render_element(element, data_context)
|
||||||
|
|
||||||
|
mock_display_manager.draw_weather_icon.assert_called_once_with("cloudy", 10, 20, 16)
|
||||||
|
|
||||||
|
def test_render_element_rectangle(self, layout_manager, mock_display_manager):
|
||||||
|
"""Test rendering a rectangle element."""
|
||||||
|
element = {
|
||||||
|
"type": "rectangle",
|
||||||
|
"x": 10,
|
||||||
|
"y": 20,
|
||||||
|
"properties": {
|
||||||
|
"width": 50,
|
||||||
|
"height": 30,
|
||||||
|
"color": [255, 0, 0],
|
||||||
|
"filled": True
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Mock the draw object and rectangle method
|
||||||
|
mock_draw = MagicMock()
|
||||||
|
mock_display_manager.draw = mock_draw
|
||||||
|
|
||||||
|
layout_manager.render_element(element, {})
|
||||||
|
|
||||||
|
# Verify rectangle was drawn
|
||||||
|
mock_draw.rectangle.assert_called_once()
|
||||||
|
|
||||||
|
def test_render_element_unknown_type(self, layout_manager):
|
||||||
|
"""Test rendering an unknown element type."""
|
||||||
|
element = {
|
||||||
|
"type": "unknown_type",
|
||||||
|
"x": 0,
|
||||||
|
"y": 0,
|
||||||
|
"properties": {}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Should not raise an exception
|
||||||
|
layout_manager.render_element(element, {})
|
||||||
|
|
||||||
|
def test_process_template_text(self, layout_manager):
|
||||||
|
"""Test template text processing."""
|
||||||
|
text = "Hello {name}, temperature is {temp}°F"
|
||||||
|
data_context = {
|
||||||
|
"name": "World",
|
||||||
|
"temp": 72
|
||||||
|
}
|
||||||
|
|
||||||
|
result = layout_manager._process_template_text(text, data_context)
|
||||||
|
|
||||||
|
assert result == "Hello World, temperature is 72°F"
|
||||||
|
|
||||||
|
def test_process_template_text_no_context(self, layout_manager):
|
||||||
|
"""Test template text with missing context."""
|
||||||
|
text = "Hello {name}"
|
||||||
|
data_context = {}
|
||||||
|
|
||||||
|
result = layout_manager._process_template_text(text, data_context)
|
||||||
|
|
||||||
|
# Should leave template as-is or handle gracefully
|
||||||
|
assert "{name}" in result or result == "Hello "
|
||||||
|
|
||||||
|
def test_save_layouts_error_handling(self, layout_manager):
|
||||||
|
"""Test error handling when saving layouts."""
|
||||||
|
# Create a layout
|
||||||
|
layout_manager.create_layout("test", [])
|
||||||
|
|
||||||
|
# Make save fail by using invalid path
|
||||||
|
layout_manager.config_path = "/nonexistent/directory/layouts.json"
|
||||||
|
|
||||||
|
result = layout_manager.save_layouts()
|
||||||
|
|
||||||
|
# Should handle error gracefully
|
||||||
|
assert result is False
|
||||||
|
|
||||||
|
def test_render_element_line(self, layout_manager, mock_display_manager):
|
||||||
|
"""Test rendering a line element."""
|
||||||
|
element = {
|
||||||
|
"type": "line",
|
||||||
|
"x": 10,
|
||||||
|
"y": 20,
|
||||||
|
"properties": {
|
||||||
|
"x2": 50,
|
||||||
|
"y2": 30,
|
||||||
|
"color": [255, 0, 0],
|
||||||
|
"width": 2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
mock_draw = MagicMock()
|
||||||
|
mock_display_manager.draw = mock_draw
|
||||||
|
|
||||||
|
layout_manager.render_element(element, {})
|
||||||
|
|
||||||
|
mock_draw.line.assert_called_once()
|
||||||
|
|
||||||
|
def test_render_element_clock(self, layout_manager, mock_display_manager):
|
||||||
|
"""Test rendering a clock element."""
|
||||||
|
element = {
|
||||||
|
"type": "clock",
|
||||||
|
"x": 10,
|
||||||
|
"y": 20,
|
||||||
|
"properties": {
|
||||||
|
"format": "%H:%M",
|
||||||
|
"color": [255, 255, 255]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
layout_manager.render_element(element, {})
|
||||||
|
|
||||||
|
mock_display_manager.draw_text.assert_called_once()
|
||||||
|
|
||||||
|
def test_render_element_data_text(self, layout_manager, mock_display_manager):
|
||||||
|
"""Test rendering a data text element."""
|
||||||
|
element = {
|
||||||
|
"type": "data_text",
|
||||||
|
"x": 10,
|
||||||
|
"y": 20,
|
||||||
|
"properties": {
|
||||||
|
"data_key": "weather.temperature",
|
||||||
|
"format": "Temp: {value}°F",
|
||||||
|
"color": [255, 255, 255],
|
||||||
|
"default": "N/A"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
data_context = {
|
||||||
|
"weather": {
|
||||||
|
"temperature": 72
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
layout_manager.render_element(element, data_context)
|
||||||
|
|
||||||
|
mock_display_manager.draw_text.assert_called_once()
|
||||||
@@ -404,15 +404,9 @@
|
|||||||
if (!file) return;
|
if (!file) return;
|
||||||
|
|
||||||
const formData = new FormData();
|
const formData = new FormData();
|
||||||
// Backend contract (see api_v3.upload_plugin_asset): the request
|
formData.append('file', file);
|
||||||
// field must be named "files" (it does request.files.getlist('files')
|
|
||||||
// and 400s with "No files provided" otherwise), and the response
|
|
||||||
// carries the result in a top-level "uploaded_files" key, not nested
|
|
||||||
// under "data". file-upload-single.js's working upload flow uses this
|
|
||||||
// same contract.
|
|
||||||
formData.append('files', file);
|
|
||||||
formData.append('plugin_id', pluginId);
|
formData.append('plugin_id', pluginId);
|
||||||
|
|
||||||
fetch('/api/v3/plugins/assets/upload', {
|
fetch('/api/v3/plugins/assets/upload', {
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
body: formData
|
body: formData
|
||||||
@@ -427,8 +421,8 @@
|
|||||||
return response.json();
|
return response.json();
|
||||||
})
|
})
|
||||||
.then(data => {
|
.then(data => {
|
||||||
if (data.status === 'success' && data.uploaded_files && data.uploaded_files.length > 0) {
|
if (data.status === 'success' && data.data && data.data.files && data.data.files.length > 0) {
|
||||||
const uploadedFile = data.uploaded_files[0];
|
const uploadedFile = data.data.files[0];
|
||||||
const row = document.querySelector(`#${fieldId}_tbody tr[data-index="${index}"]`);
|
const row = document.querySelector(`#${fieldId}_tbody tr[data-index="${index}"]`);
|
||||||
if (row) {
|
if (row) {
|
||||||
const logoCell = row.querySelector('td:nth-child(3)');
|
const logoCell = row.querySelector('td:nth-child(3)');
|
||||||
|
|||||||
Reference in New Issue
Block a user