mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-17 20:39:13 +00:00
ChuckBuildsandClaude Opus 5
60d5d19898
web_interface/blueprints/api_v3.py held 111 routes, 56 helpers and 181 functions in one module -- 9% of the core by line count and three times the next largest file. It becomes a package of nine route modules grouped by path segment, plus __init__.py for the shared imports, constants, Blueprint and helpers. Every route module decorates the SAME api_v3 Blueprint object, so endpoint names stay api_v3.<function>, the URL map is unchanged and app.py is untouched. Verified: 111 routes before, 111 after, byte-identical rules, endpoints and methods, and every endpoint still on the one blueprint. plugins 3,867 config 1,178 starlark 692 system 619 fonts 452 misc 398 wifi 361 display 326 backup 212 __init__ 1,787 (imports, constants, Blueprint, 56 helpers) Two things the URL-map check could not catch, both found by running the suite: 1. PROJECT_ROOT = Path(__file__).parent.parent.parent. Moving the code one directory deeper made that resolve to web_interface/ instead of the project root. Nothing failed at import; it surfaced as ~110 tests failing with 404s and "installation script not found", because every path built from it was one level too shallow. Now parents[3], and test_api_v3_url_map.py asserts PROJECT_ROOT/run.py exists so the next move cannot repeat it. 2. Module-attribute patching. Tests do monkeypatch.setattr(api_v3_module, "_BACKUP_EXPORT_DIR", ...) and a route module that binds such a name by value never sees the patch. The shared code therefore stays in __init__.py rather than moving to a _common submodule -- it has to live on the module the tests patch -- and the eleven names tests patch are read back through the package (_pkg.X) instead of bound by value. Those eleven were found by AST-scanning every setattr in the test tree, not by guessing; "time" is among them, used to drive a fake clock through the second-resolution credential-backup filenames. Test changes are confined to what genuinely moved: patch targets that now name the owning route module, imports of helpers, and six tests that scan the api_v3 source as a file and now read the package directory. Full suite: 4,278 passed, 68 skipped, 0 failed. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014RRtqXDCnvnY6EQwhT5CV9
46 lines
2.0 KiB
Python
46 lines
2.0 KiB
Python
"""The validation logging ran before separate_secrets, so it logged credentials.
|
|
|
|
api_v3's plugin-config save logged `Full config: {plugin_config}` at INFO and
|
|
`Config that failed: {plugin_config}` at ERROR. Both run *before*
|
|
separate_secrets(), so plugin_config still held the values the user just typed
|
|
into the form -- API keys and tokens went to the journal in clear text.
|
|
"""
|
|
import re
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
API_V3_PKG = (Path(__file__).resolve().parents[2]
|
|
/ "web_interface" / "blueprints" / "api_v3")
|
|
|
|
#: Objects that still hold submitted secret values at the point these log
|
|
#: calls run. Interpolating one whole into a log message leaks credentials.
|
|
UNREDACTED = ("plugin_config", "secrets_config", "current_secrets")
|
|
|
|
|
|
def _logging_lines():
|
|
for number, line in enumerate("\n".join(p.read_text(encoding="utf-8") for p in sorted(API_V3_PKG.glob("*.py"))).splitlines(), 1):
|
|
stripped = line.strip()
|
|
if stripped.startswith("#"):
|
|
continue
|
|
if re.match(r"logger\.(debug|info|warning|error|critical|exception)\(", stripped):
|
|
yield number, stripped
|
|
|
|
|
|
@pytest.mark.parametrize("name", UNREDACTED)
|
|
def test_no_log_call_interpolates_a_whole_secret_bearing_object(name):
|
|
# {name} or {name['k']} leaks; {list(name.keys())} and {len(name)} do not.
|
|
bare = re.compile(r"\{" + re.escape(name) + r"(\[[^\]]*\])*\}")
|
|
offenders = [f"{n}: {text}" for n, text in _logging_lines() if bare.search(text)]
|
|
assert not offenders, (
|
|
f"{name} still holds submitted secrets where these log calls run:\n "
|
|
+ "\n ".join(offenders))
|
|
|
|
|
|
def test_the_guard_would_notice_a_reintroduced_leak():
|
|
"""Pin the detector itself, so a rewrite cannot silently stop matching."""
|
|
bare = re.compile(r"\{" + re.escape("plugin_config") + r"(\[[^\]]*\])*\}")
|
|
assert bare.search('logger.info(f"Full config: {plugin_config}")')
|
|
assert bare.search("logger.error(f\"{plugin_config['api_key']}\")")
|
|
assert not bare.search('logger.info(f"{list(plugin_config.keys())}")')
|