mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-08 12:18:06 +00:00
Follow-ups from #441: secret-helper migration, ten more bug fixes, and coverage for every remaining untested module (#444)
* refactor(web): use canonical secret helpers in api_v3; make ConfigManager secret strip/merge array-aware
api_v3.py carried three inline nested copies of find_secret_fields/
separate_secrets (main-config save, plugin-config save, plugin-config
reset). They drifted from each other (one lacked isinstance guards) and
none supported the canonical module's array-item secrets
(accounts[].token). All three endpoints now import from
src/web_interface/secret_helpers.
Adopting the canonical behavior makes array-item secrets reachable, and
their parallel-placeholder shape ([{'token': ...}, {}] alongside the
regular list) was not survivable by ConfigManager's round-trip:
_strip_secrets_recursive dropped the whole key (losing the regular
fields from config.json) and _deep_merge replaced the regular list
wholesale on load. Both are now array-aware:
- strip removes the secret fields from each item and ALWAYS keeps the
list so indices survive for merge-on-load; whole-key secrets (scalar
lists, shape mismatches) still drop the key entirely — never leak.
- merge folds each secrets item into the config item at the same index,
skipping {} placeholders. The regular list's length is authoritative
in both directions: a user deleting an array item never has it
resurrected from a stale secrets entry (extras warn and are ignored).
api_v3's own deep_merge intentionally still replaces lists wholesale —
form posts carry complete arrays and index-merging would resurrect
deleted items; a comment now documents that.
Tests: the parity guard flips from 'exactly 3 inline copies' to 'zero,
and the canonical import must exist'; TestArraySecretStripAndMerge
covers the new strip/merge semantics incl. length-mismatch contracts;
new test_api_v3_secret_roundtrip.py drives all three endpoints through
a Flask client with a REAL ConfigManager+SchemaManager over tmp_path,
proving secrets land in config_secrets.json, config.json stays clean,
and a fresh load merges them back into the right array items.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* fix: repair broken helper paths across display, cache, odds, logging, resolver, repos, config, validator
Nine fixes for bugs surfaced while writing coverage for previously
untested modules (plus the bool-duration quirk pinned in PR #441):
- base_plugin.get_display_duration: exclude bools from both numeric
branches — display_duration=True no longer reads as a 1-second slot;
it falls through to config, then the 15.0 default.
- display_helper: draw_error_message/draw_no_data_message called
_draw_centered_text with the wrong arguments and crashed with
AttributeError — both now delegate to draw_centered_text.
draw_scorebug_layout drew status and clock at the same y, overprinting
each other — they now share one combined top line.
draw_ticker_layout drew its text starting at x=display_width (fully
off-canvas), returning a blank frame every time — now draws at x=0;
scroll_speed stays accepted-but-unused and is documented as such.
- api_helper.clear_cache guarded on a nonexistent CacheManager.clear()
method, silently never clearing anything; it now uses the real surface
(clear_cache/delete/list_cache_files) and no-ops safely otherwise.
- base_odds_manager._extract_espn_data raised AttributeError when ESPN
sent explicit JSON nulls ("homeTeamOdds": null) — every level now
null-safes with 'or {}'. format_odds_summary gated on
is_odds_available, which deliberately ignores money lines, so
ML-only odds formatted as "No odds available" — it now gates only on
empty/no_odds data and formats money lines.
- logging_config.ContextualFormatter mutated record.msg in place, so a
second handler prepended the context prefix twice; it now formats a
copy. log_error hardcoded exc_info=True and raised TypeError when the
caller passed exc_info — now kwargs.setdefault.
- dynamic_team_resolver wrote its "shared" class cache through self,
creating instance shadows — the cache was per-instance and every
scoreboard refetched rankings. Writes now go through the class.
- saved_repositories cleaned URLs with an unanchored .replace('.git','')
that mangled URLs merely containing '.git' (my.github.io -> myhub.io);
now strips only a trailing suffix. add/remove also roll back the
in-memory list when the save fails, so memory always matches disk.
- config_helper.merge_configs shallow-copied the base, aliasing every
un-overridden nested dict into the result — now deep-copies.
- startup_validator.validate_all accumulated errors/warnings across
calls — now resets both lists per run.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* test: cover the previously untested modules
Nine new suites plus an extension, asserting the Phase-1b fixed behavior
and pinning the quirks deliberately left alone:
- test_logging_config.py: formatters (JSON shape, no record mutation,
single prefix through two handlers), PluginLoggerAdapter precedence,
setup_logging handler hygiene and LEDMATRIX_DEBUG, log_error exc_info.
- test_startup_validator.py: exact messages, error-vs-warning split,
accessor split (load_config vs get_config), cache-dir branches with
os.access monkeypatched (root can write anything in CI), idempotence,
raise_on_errors classification precedence.
- test_config_helper.py (full): load/save round trips, dot-notation
get/set incl. silent-failure contract, post-fix no-aliasing merge,
schema validation branches, the '{id}_config' key pin, default-enabled
pin.
- test_saved_repositories.py: three load shapes, bare-list rewrite pin,
trailing-only .git strip (my.github.io regression), save-failure
rollback, type-classification case-sensitivity pin.
- test_api_helper.py: rate-limit math, cache-hit short circuit, ESPN
URL/key formats, exact User-Agent guard, retry adapter, post-fix
clear_cache against the real CacheManager surface, ttl-dropped pin.
- test_base_odds_manager.py: cache-key/URL construction, no_odds
sentinel round trip, stale-cache fallback, null-safe extraction,
ML-only formatting, is_odds_available truth table (ML-blind by
contract), config key/attr mismatch pin.
- test_dynamic_team_resolver.py: expansion/dedup/slicing, dropped
unknown-dynamic names (TOP_ substring hazard pinned), genuinely
shared class cache (second instance: zero HTTP), TTL expiry,
failure degradation without raising.
- test_display_helper.py (full): the fixed error/no-data renders,
combined scorebug top line, non-blank ticker with scroll_speed
no-op pin, composite upconversion, logo bleed positions, square
orientation pin.
- test_skin_runtime_cache.py: discovery-cache hit/invalidation
semantics (manifest mtime, .py edits pinned as non-invalidating),
sys.modules namespacing contract incl. bare-name restore and stdlib
shadowing, entry-module execute-once, API minor-version tolerance,
skin_matches_target table.
- test_sports_capabilities.py (extended): _draw_celebration_layout
executed for real (flash window, matrix-dims fallback, highlight
alternation, logo-failure isolation), _should_celebrate_for direct,
strict duration boundary, score_to_int edges, both-teams-score
precedence, expired-coalesce refire, disabled-win baseline
preservation, id-less prune.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* test: real schedule/dim coverage for DisplayController; fix two vacuous schedule tests
New test_display_controller_schedule.py drives _check_schedule and
_check_dim_schedule on a bare controller stub: same-day and
midnight-crossing windows with inclusive boundaries, global vs per-day vs
legacy-inferred modes (and dim's global-only default — no legacy
inference), per-day disabled days, invalid %H:%M fallbacks, unknown
timezone -> UTC, dim_brightness default 30, inactive-display short
circuit, and the _was_display_active/_was_dimmed transition flags.
test_display_controller.py's test_schedule_disabled and
test_active_hours patched config_service.get_config — which
_check_schedule never reads — so both asserted the init-default value
and could not fail. Rewritten on the test_inactive_hours pattern
(inject controller.config['schedule'], reset the minute gate, flip the
flag to the opposite state first so the assertion has teeth).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* ci: raise coverage floor to 48%
Measured 50% with the new suites in place (was 47% baseline when the
gate was introduced at 45); floor stays two points under measured.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* fix: address CodeQL alert and review findings
- config_manager: the "secrets list longer than config list" warning now
interpolates only config-side data (no key name or secrets-derived
values), resolving the CodeQL clear-text-logging alert.
- base_plugin: validate_config rejects bool display_duration, matching
get_display_duration (bool is an int subclass and would otherwise pass
as a positive number).
- config_helper: merge_configs deep-copies override values in the
non-recursive branch so mutating the merged result cannot reach back
into override_config.
- saved_repositories: saves are atomic (temp file + fsync + os.replace),
so a failed write can no longer truncate saved_repositories.json.
- tests: regression cases for each fix, plus a pin that whole-item
array secrets (key[] + key[].field both marked) strip to empty {}
skeletons — no secret values can reach config.json.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
---------
Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -878,3 +878,200 @@ class TestCapabilityExports:
|
||||
def test_rotation_strategy_base_requires_a_schedule(self):
|
||||
with pytest.raises(NotImplementedError):
|
||||
RotationStrategy().schedule([game("a")])
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Celebrations: rendering + previously untested edges
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
from PIL import Image, ImageDraw, ImageFont # noqa: E402
|
||||
|
||||
|
||||
class _RenderableLive(_FakeLive):
|
||||
"""A _FakeLive that can actually execute _draw_celebration_layout:
|
||||
real fonts, a display manager holding a real PIL image, and the two
|
||||
SportsCore drawing seams the mixin calls."""
|
||||
|
||||
def __init__(self, mode_config=None, favorite_teams=None,
|
||||
width=128, height=32, with_matrix=True):
|
||||
super().__init__(mode_config=mode_config, favorite_teams=favorite_teams)
|
||||
font = ImageFont.load_default()
|
||||
self.fonts = {"time": font, "status": font, "score": font}
|
||||
self.display_width = width
|
||||
self.display_height = height
|
||||
dm = MagicMock()
|
||||
if with_matrix:
|
||||
dm.matrix.width = width
|
||||
dm.matrix.height = height
|
||||
else:
|
||||
dm.matrix = None
|
||||
dm.image = Image.new("RGB", (width, height))
|
||||
self.display_manager = dm
|
||||
self.logo_calls = []
|
||||
|
||||
def _load_and_resize_logo(self, team_id, abbr, path, url):
|
||||
self.logo_calls.append(abbr)
|
||||
logo = Image.new("RGBA", (10, 10), (0, 200, 0, 255))
|
||||
return logo
|
||||
|
||||
def _draw_text_with_outline(self, draw, text, position, font, fill=(255, 255, 255)):
|
||||
draw.text(position, str(text), font=font, fill=fill)
|
||||
|
||||
|
||||
class _RenderableCelebrating(CelebrationMixin, _RenderableLive):
|
||||
pass
|
||||
|
||||
|
||||
def _armed(manager, *, kind="score", side="home", started_ago=0.0):
|
||||
manager._start_celebration(
|
||||
game("g1", home_score=7, away_score=3), kind,
|
||||
scored_side=side, team_abbr="HOM", away_score=3, home_score=7,
|
||||
points=7,
|
||||
)
|
||||
manager.active_celebration["started_at"] = time.time() - started_ago
|
||||
return manager.active_celebration
|
||||
|
||||
|
||||
class TestDrawCelebrationLayout:
|
||||
"""The takeover render path, executed for real (previously always
|
||||
mocked out)."""
|
||||
|
||||
def test_renders_and_hands_frame_to_display_manager(self):
|
||||
manager = _RenderableCelebrating()
|
||||
celebration = _armed(manager)
|
||||
manager._draw_celebration_layout(celebration)
|
||||
# The final frame was assigned and pushed.
|
||||
assert isinstance(manager.display_manager.image, Image.Image)
|
||||
assert manager.display_manager.image.mode == "RGB"
|
||||
assert manager.display_manager.image.size == (128, 32)
|
||||
manager.display_manager.update_display.assert_called_once()
|
||||
assert manager.display_manager.image.convert("L").getbbox() is not None
|
||||
|
||||
def test_force_clear_clears_display_first(self):
|
||||
manager = _RenderableCelebrating()
|
||||
celebration = _armed(manager)
|
||||
manager._draw_celebration_layout(celebration, force_clear=True)
|
||||
manager.display_manager.clear.assert_called_once()
|
||||
|
||||
def test_flash_background_within_first_window(self):
|
||||
# elapsed < 1.2 with int(elapsed/0.2) even -> flash color backdrop.
|
||||
manager = _RenderableCelebrating()
|
||||
celebration = _armed(manager, started_ago=0.05)
|
||||
manager._draw_celebration_layout(celebration)
|
||||
flash = manager.display_manager.image
|
||||
# After the flash window: plain black backdrop.
|
||||
celebration["started_at"] = time.time() - 5
|
||||
manager._draw_celebration_layout(celebration)
|
||||
steady = manager.display_manager.image
|
||||
# Corner pixels (away from logos/text) show the two backgrounds.
|
||||
assert flash.getpixel((64, 30)) != steady.getpixel((64, 30)) or \
|
||||
flash.getpixel((3, 0)) != steady.getpixel((3, 0))
|
||||
|
||||
def test_matrix_dims_fallback_to_display_attrs(self):
|
||||
manager = _RenderableCelebrating(width=96, height=48, with_matrix=False)
|
||||
celebration = _armed(manager)
|
||||
manager._draw_celebration_layout(celebration)
|
||||
assert manager.display_manager.image.size == (96, 48)
|
||||
|
||||
def test_highlight_color_alternates_with_elapsed(self):
|
||||
manager = _RenderableCelebrating()
|
||||
celebration = _armed(manager)
|
||||
# int(elapsed*4) % 2 == 0 -> yellow; == 1 -> orange. Force each phase
|
||||
# and diff the frames.
|
||||
celebration["started_at"] = time.time() - 2.0 # 8 -> even
|
||||
manager._draw_celebration_layout(celebration)
|
||||
even = manager.display_manager.image.tobytes()
|
||||
celebration["started_at"] = time.time() - 2.25 # 9 -> odd
|
||||
manager._draw_celebration_layout(celebration)
|
||||
odd = manager.display_manager.image.tobytes()
|
||||
assert even != odd
|
||||
|
||||
def test_logo_failure_still_renders_text(self):
|
||||
manager = _RenderableCelebrating()
|
||||
|
||||
def boom(*a, **k):
|
||||
raise RuntimeError("disk gone")
|
||||
|
||||
manager._load_and_resize_logo = boom
|
||||
celebration = _armed(manager, started_ago=5) # steady background
|
||||
manager._draw_celebration_layout(celebration) # must not raise
|
||||
assert manager.display_manager.image.convert("L").getbbox() is not None
|
||||
manager.display_manager.update_display.assert_called_once()
|
||||
|
||||
|
||||
class TestCelebrationEdges:
|
||||
def test_should_celebrate_for_three_way_branch(self, celebrating):
|
||||
g = game("g1", home="FAV", away="OPP")
|
||||
favored = celebrating(favorites=["FAV"])
|
||||
assert favored._should_celebrate_for(g, "home") is True # favorite
|
||||
assert favored._should_celebrate_for(g, "away") is False # opponent
|
||||
favored.celebrate_opponent_scores = True
|
||||
assert favored._should_celebrate_for(g, "away") is True # opted in
|
||||
unconfigured = celebrating(favorites=[])
|
||||
assert unconfigured._should_celebrate_for(g, "away") is True # no favs
|
||||
|
||||
def test_active_celebration_boundary_is_strict(self, celebrating):
|
||||
manager = celebrating(mode_config={"celebration_duration": 3})
|
||||
manager.active_celebration = {"started_at": time.time() - 3.0}
|
||||
# elapsed == duration -> strictly-less-than comparison says done.
|
||||
assert manager.has_active_celebration() is False
|
||||
manager.active_celebration = None
|
||||
assert manager.has_active_celebration() is False
|
||||
|
||||
@pytest.mark.parametrize("value,expected", [
|
||||
({"value": None}, None), # int(float(None)) TypeError -> caught
|
||||
({"value": "abc"}, None),
|
||||
({"other": 1}, 0), # neither key -> default 0
|
||||
([3], None), # list -> TypeError -> caught
|
||||
("-4", None), # regex fallback finds digits -> 4? No:
|
||||
])
|
||||
def test_score_to_int_edges(self, value, expected):
|
||||
result = CelebrationMixin._score_to_int(value)
|
||||
if value == "-4":
|
||||
# int(float("-4")) parses directly: -4.
|
||||
assert result == -4
|
||||
else:
|
||||
assert result == expected
|
||||
|
||||
def test_both_teams_scoring_prefers_away(self, celebrating):
|
||||
manager = celebrating(favorites=[])
|
||||
manager._check_for_score(game("g1", home_score=0, away_score=0))
|
||||
manager._check_for_score(game("g1", home_score=7, away_score=3))
|
||||
assert manager.active_celebration["scored_side"] == "away"
|
||||
|
||||
def test_away_not_celebratable_falls_through_to_home(self, celebrating):
|
||||
manager = celebrating(favorites=["HOM"]) # away is the opponent
|
||||
manager._check_for_score(game("g1", home_score=0, away_score=0))
|
||||
manager._check_for_score(game("g1", home_score=7, away_score=3))
|
||||
assert manager.active_celebration["scored_side"] == "home"
|
||||
|
||||
def test_coalesce_expired_celebration_fires_fresh(self, celebrating):
|
||||
manager = celebrating(cls=_Coalescing,
|
||||
mode_config={"celebration_duration": 1})
|
||||
manager._check_for_score(game("g1"))
|
||||
manager._check_for_score(game("g1", home_score=6))
|
||||
first = manager.active_celebration
|
||||
assert first is not None
|
||||
first["started_at"] = time.time() - 2 # expired
|
||||
manager._check_for_score(game("g1", home_score=7))
|
||||
# A new celebration replaced the expired one (coalescing only
|
||||
# suppresses while one is actively on screen).
|
||||
assert manager.active_celebration is not first
|
||||
assert manager.active_celebration["home_score"] == 7
|
||||
|
||||
def test_disabled_win_check_preserves_baseline(self, celebrating):
|
||||
manager = celebrating(favorites=["HOM"])
|
||||
manager._check_for_score(game("g1"))
|
||||
assert "g1" in manager._score_baselines
|
||||
manager.celebration_enabled = False
|
||||
manager._check_for_win(game("g1", home_score=7))
|
||||
# Early return BEFORE consuming the baseline: re-enabling later can
|
||||
# still fire for this game.
|
||||
assert "g1" in manager._score_baselines
|
||||
|
||||
def test_prune_drops_baselines_for_idless_live_games(self, celebrating):
|
||||
manager = celebrating()
|
||||
manager._score_baselines = {"g1": {"away": 0, "home": 0}}
|
||||
manager.prune_score_baselines([{"no_id_here": True}])
|
||||
# live ids collapse to {None}; g1 is not live -> dropped.
|
||||
assert manager._score_baselines == {}
|
||||
|
||||
Reference in New Issue
Block a user