mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-04 14:25:08 +00:00
fix: /errors stack traces, Wi-Fi disconnect and save, plugin fonts, API cache TTL (#636)
* fix(errors): record the exception's own stack trace record_error() called traceback.format_exc(), which only sees an exception while its except block is running. plugin_executor records exceptions caught on a worker thread after that block has ended, so every trace on /errors read "NoneType: None". The trace is now built from the exception's __traceback__. The executor's log call had the same problem with exc_info=True and now passes the exception. record_error() also merged LEDMatrixError context into the caller's dict in place; it now works on a copy. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(wifi): point at configure_wifi_permissions.sh instead of a sudoers list The module docstring told users to grant NOPASSWD sudo on iptables and ip. configure_wifi_permissions.sh refuses those grants on purpose: a wildcard rule for either runs an arbitrary program as root. Point at the script and say why it leaves them out. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(wifi): disconnect finds the saved profile by SSID disconnect_from_network() asked `nmcli -f NAME,802-11-wireless.ssid connection show` for the profile to take down, but nmcli rejects that column for `connection show`, so the lookup always failed and only the device was disconnected. The per-profile lookup _connect_nmcli() already used is now _find_profile_for_ssid(), and both callers share it. It also splits terse output on the last colon and unescapes "\:", so a profile name containing a colon is found. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(wifi): write wifi_config.json atomically and report a failed save _save_config() opened the file for writing in place and swallowed any error, so a wifi_config.json left owned by root made the web toggle for auto-enabling AP mode report success while nothing was saved, and a crash mid-write could truncate the file. It now uses atomic_write_json, which also keeps the file's owner and shared group when root saves it, and returns False on failure. POST /wifi/ap/auto-enable answers 500 in that case. The file is now written with indent=4, like the other config files. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(fonts): resolve plugin:// fonts in the plugin's own directory FontManager looked for a plugin's bundled fonts under Path("plugins") / plugin_id: relative to the process cwd, and not the default install directory (plugin-repos/), so a manifest's plugin:// fonts never loaded. register_plugin_fonts() takes an optional plugin_dir, and PluginManager passes the directory it loaded the plugin from. Callers that omit it get a lookup in the configured plugin_system.plugins_directory, then plugins/, resolved against the install root. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(api-helper): cache responses for the requested cache_ttl APIHelper.get(cache_ttl=...) and set_cache(ttl=...) dropped the ttl on the claim that CacheManager does not support one, but CacheManager.set() takes a ttl, stores it with the entry, and both cache tiers honour it over a reader's max_age. Without it every response expired after the 300-second default read age, whatever the plugin asked for. The ttl is now passed through, and the cache read passes cache_ttl as max_age for entries written without one. The class docstring describes what the helper actually does. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(style): one scale range for the schema, element_scale and LogoHelper The generated Scale field allowed 0.1 to 10, element_style's reader capped at 10 with no floor, and LogoHelper accepted 0.05 to 8 and reset anything else to 1.0. A logo scale of 9, which the form accepts, drew at the shipped size. MIN_ELEMENT_SCALE / MAX_ELEMENT_SCALE (0.1, 10.0) in src.element_style are now the schema bounds and the clamp every reader applies through coerce_scale(): a positive number outside the range is clamped, and anything that is not a finite positive number means the default. That also stops element_scale() passing NaN through, since min(nan, 10.0) is nan. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(logos): placeholder lands at the requested path; empty logos list download_missing_logo() wrote its fallback placeholder to <normalize_abbreviation(abbr)>.png in the logo directory rather than to the logo_path the caller passed, so it could return True while nothing existed where the plugin looks (e.g. "TA&M.png" vs "TAANDM.png"). create_placeholder_logo() takes an optional filepath, and download_missing_logo passes the requested one. download_missing_logo_for_team() only caught KeyError, so a team whose "logos" list is empty raised IndexError; it now treats KeyError, IndexError and TypeError as "no logo URL". The placeholder is drawn with PLACEHOLDER_SIZE / PLACEHOLDER_BG, the constants is_placeholder_logo() recognises it by, instead of repeated literals. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(fonts): resolve bundled font paths against the install root TextHelper's default font_dir, the logo placeholder's font and FontManager's font_overrides.json were all relative to the process cwd, so a process started anywhere but the install root (the plugin safety harness, a manual run, a unit without WorkingDirectory) drew with PIL's default face and read no overrides. They now go through font_layout.resolve_asset_path; the overrides file sits in the install root's config/. The resolver docstrings described an order the code does not follow: resolve_asset_path never consults the cwd, and sports_shared's _resolve_font_path tries the cwd first. Both docstrings now say what the code does, and _resolve_font_path calls resolve_asset_path instead of probing FontManager for it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(sync): the web UI reads the sync status file the display writes sync_manager writes its status to tempfile.gettempdir(), but GET /api/v3/sync/status read a hardcoded /tmp/led_matrix_sync_status.json and defaulted the port to a literal 5765. Wherever TMPDIR is set (or on any non-/tmp host) the page only ever showed "starting". The endpoint now uses sync_manager.STATUS_FILE and SYNC_PORT. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(http): the rankings resolver sends the project's User-Agent DynamicTeamResolver fetched ESPN rankings with a bare requests.get, so it sent python-requests' default User-Agent, which ESPN rejects; the AP_TOP_N favourites then resolved to nothing. It now sends DEFAULT_HTTP_HEADERS. BaseOddsManager carried its own copy of the User-Agent string and now uses the same shared headers (which also adds Accept-Language). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(backup): record the core release and read the configured plugin dir The manifest's ledmatrix_version came from a VERSION file that does not exist, then from .git/HEAD: a 12-character sha, or "ref: refs/he" when the branch's ref was packed. It is now src.__version__. list_installed_plugins() scanned a hardcoded plugin-repos/, so on an install whose plugin_system.plugins_directory points elsewhere, plugins missing from plugin_state.json were left out of the backup. It now reads the configured directory from config/config.json, defaulting to plugin-repos. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(startup): report a missing display section once A config without a display section produced three errors for the one problem ("Missing required configuration key: display", "Display configuration is missing or empty" and "Display configuration is missing"), and an empty one produced two. _validate_config now reports it once, as a missing key or an empty section, and _validate_display_config leaves it to that. The module docstring said the validator fails fast; nothing in the display service calls raise_on_errors(), so it now says the errors are reported and startup continues. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(wifi): share the copied blocks and name the AP constants - _parse_nmcli_wifi_list() is the one parser behind _scan_nmcli and _scan_nmcli_cached. - _verify_connected(), _wait_for_device_idle(), _failsafe_ap() and _mark_forced() replace blocks that were pasted two or three times in the connect and enable-AP paths. The device-idle wait now checks before its first one-second sleep instead of after it. - _check_command() calls _find_command_path() instead of repeating it. - AP_IP, PORTAL_PORT, AP_PROFILE_NAME and AP_PROFILE_NAMES name values that were spelled out 14, 12, 8 and 2 times; the two deletion loops now walk the same tuple. The iwconfig status path compares the AP address exactly: startswith() also skipped 192.168.4.10-19. - Dropped a second WIFI.SIGNAL query that repeated the first, a no-op "if ssid: continue", the try/except around _connect_wpa_supplicant's constant return, and a second save of a scan scan_networks already saves. - _ensure_wifi_radio_enabled's docstring says it returns True when the radio state cannot be read at all. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(config): drop dead branches and history comments in ConfigManager - The module docstring pointed plugin authors at update_plugin_config(), which does not exist; it now names save_config_atomic() and save_raw_file_content(). - load_config's FileNotFoundError handler tested the message for "config_secrets.json", but a missing secrets file is handled where it is read, so only config.json reaches it; the check is gone. - save_raw_file_content's `file_type == "main" or "secrets"` guard was always true (anything else raised earlier). - get_raw_file_content('secrets') already returns {} for a missing file, so the os.path.exists() in front of two calls to it is gone. - Comments that narrated earlier behaviour are rewritten as what the code does now. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(background-data): present-tense comments, drop unused API - Comments that told the history of each fix (what "used to" happen, "the old per-delivery release") now state the invariant the code keeps. - get_statistics() no longer reports a constant 'queue_size': 0, and the uncalled clear_completed_requests() is gone (_cleanup_completed_requests does that job on every completion). Neither is referenced in core, the web UI or the plugin monorepo. shutdown_background_service() has no production caller either, but it is the only way to tear down the get_background_service() singleton, which the tests rely on, so it stays. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(odds): drop the unread cache_ttl and merge the odds_data branches BaseOddsManager loaded base_odds_manager.cache_ttl from config and never used it: cached odds live for the update interval (get_odds' ttl=interval). No core or monorepo code reads the attribute, so it is gone along with its log line. The two consecutive `if odds_data:` blocks are one. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(backup): one table for the single-file sections config, secrets, wifi and ytm_auth were each spelled out in create, preview, validate and restore. _SINGLE_FILE_SECTIONS lists them once, with the RestoreOptions flag that restores each, and all four walk it. Restore error messages keep their wording ("Failed to restore <file name>"). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(fonts): drop FontManager's write-only state and duplicate logs - fonts_config, font_metadata and font_dependencies were written and never read; the performance_stats keys font_load_times, render_times, total_renders and the per-call "resolve" timings (_record_performance_metric) likewise. get_performance_stats() reads only the counters that remain. Nothing in core or the plugin monorepo references any of them. - A failed BDF load was logged twice, by _load_bdf_font and again by get_font; get_font's line is the one kept. - Removed "NEW:" and commented-out cozette entries, the "Copy font to assets/fonts" comment on code that copies nothing, and local imports of names the module already imports. The deprecated add_font() now resolves assets/fonts against the install root. The @deprecated methods stay. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(text-helper): cache loaded fonts; drop the pre-textlength fallback TextHelper declared _font_cache, cleared it and reported its size, but never stored anything in it. load_fonts() now keeps each (file, size) it loads there, so clear_font_cache() and get_font_cache_stats() mean what they say and repeated load_fonts() calls reuse the fonts. get_text_width() no longer catches AttributeError for Pillow releases without ImageDraw.textlength; requirements.txt pins Pillow>=12.2. The class docstring describes what the helper does. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(common): fix wrong docstrings in api_helper, permission_utils, snapshot_policy - permission_utils called 0o2775 "sticky bit"; the 2 is setgid, which is what makes new files take the directory's group. - snapshot_policy pointed at web_interface/blueprints/api_v3.py, which is a package now; the health check is in api_v3/misc.py. - APIHelper.clear_cache() lost a history note and a fallback to a clear() method that neither CacheManager nor the testing MockCacheManager has. The session headers are built from DEFAULT_HTTP_HEADERS instead of a copy of them, and the module docstring says what the module offers. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(sports): present-tense comments in the shared scoreboard renderers - sports_scroll and sports_game_renderer comments that referred to "this PR", "the old flat 128px card" or what the renderer "previously" did now describe the current behaviour and its reason. - The block explaining why non-finite settings are rejected sat above _score_reserve_width; it describes _center_gap_width and now lives in it. - unshare_element_fonts wrapped its import of font_layout.load_truetype in an `except ImportError` that cannot fire inside core; the import stays at call time so tests can spy on the pinned loader. - sports_card docstrings that told the history of a fix say what the code does. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(sports-shared): drop dead code, name the ESPN limit - _get_weeks_data asked for limit=1000, which fetch_espn_scoreboard clamps to ESPN_MAX_LIMIT anyway; it now names that constant. Its unused `immediate_events = []` is gone. - _get_season_schedule_dates() returned ("", "") and has no caller in core or the plugin monorepo. - _should_log keeps its warning_type parameter (part of the inherited signature, though nothing in core or the monorepo calls it) and its docstring says the cooldown is shared across types. - An unused ImageFont import is gone. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(sync): one follower-mode switch, shared panel defaults - The class docstring said the leader sends PNG frames. Frames go over UDP as raw RGB; PNG is only the Vegas scroll image sent over TCP. It now describes both paths. - _enter_follower_mode() replaces the two copies of "note the leader, switch from standalone to follower, log, write status" in the frame and scroll-position handlers. - The rows/cols fallbacks use DEFAULT_ROWS / DEFAULT_COLS from src.display_geometry, as chain_length already did. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(style): drop _layout_axis, name the layout group title - ElementStyleResolver._layout_axis() had no caller in core or the plugin monorepo. - _element_block_from_spec checked spec['size'] was a dict again after size_spec already had; it reads size_spec. - The "Layout Offsets" title written into three generated schema blocks is _LAYOUT_TITLE. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(logo-helper): say what the placeholder draws; name the 1.5 box factor - _create_placeholder_logo's docstring said it draws the team abbreviation; it draws an outlined grey box and nothing else. The docstring says so, and the "in a real implementation you'd want text" comments are gone. - The 1.5 x panel default logo box, written out six times, is DEFAULT_LOGO_BOX_FACTOR. - ImageDraw is imported with Image at the top of the module. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(logos): drop dead code and a duplicate regex in logo_downloader - _SAFE_LEAGUE_CODE_RE was the same pattern as _SAFE_LEAGUE_RE; both checks use the one. - get_logo_filename_variations reassigned the TA&M case to the list it already had; the function returns the two names directly. - _get_team_name_variations() had no caller in core or the plugin monorepo. - fetch_single_team's docstring was copied from fetch_teams_data; a log message read "for{team_id}". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor: drop the Pillow<9.1 resample shim and a catch-and-reraise - adaptive_images fell back to Image.LANCZOS/NEAREST for Pillow < 9.1; requirements.txt pins Pillow>=12.2. RESAMPLE_LANCZOS and RESAMPLE_NEAREST keep their names (src.common re-exports them). - CacheManager.save_cache caught CacheError only to re-raise it; the disk write is now called directly, with the same result. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test(api-helper): stop the real CacheManager's cleanup thread The cache-lifetime tests built a CacheManager and left its cleanup thread's class-wide claim on the directory in place, which broke test_cache_cleanup_thread_ownership when it ran later in the session. The fixture now stops the thread on teardown. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(changelog): core-common Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Chuck
+42
-13
@@ -92,7 +92,7 @@ class TestGet:
|
||||
helper.session.get.assert_not_called()
|
||||
rate_spy.assert_not_called()
|
||||
|
||||
def test_cache_miss_fetches_and_caches_without_ttl(self, helper, cache):
|
||||
def test_cache_miss_fetches_and_caches_with_ttl(self, helper, cache):
|
||||
cache.get.return_value = None
|
||||
helper.session.get = Mock(return_value=_make_response({'a': 1}))
|
||||
|
||||
@@ -100,9 +100,47 @@ class TestGet:
|
||||
cache_ttl=999)
|
||||
|
||||
assert result == {'a': 1}
|
||||
# Pin the ttl-dropped contract: CacheManager.set is called with
|
||||
# (key, data) only — the cache_ttl argument is discarded.
|
||||
cache.set.assert_called_once_with('k', {'a': 1})
|
||||
cache.set.assert_called_once_with('k', {'a': 1}, ttl=999)
|
||||
|
||||
def test_set_cache_passes_ttl(self, helper, cache):
|
||||
helper.set_cache('k', {'a': 1}, ttl=42)
|
||||
cache.set.assert_called_once_with('k', {'a': 1}, ttl=42)
|
||||
|
||||
|
||||
class TestCacheLifetimeWithRealCacheManager:
|
||||
"""cache_ttl decides how long a response is reused, in both directions:
|
||||
past CacheManager's 300-second default read age, and not beyond it."""
|
||||
|
||||
@pytest.fixture
|
||||
def real_cache(self, tmp_path):
|
||||
from unittest.mock import patch
|
||||
from src.cache_manager import CacheManager
|
||||
with patch('src.cache_manager.CacheManager._get_writable_cache_dir',
|
||||
return_value=str(tmp_path)):
|
||||
cache = CacheManager()
|
||||
yield cache
|
||||
# Releases the class-wide cleanup-thread claim on this directory,
|
||||
# which would otherwise leak into test_cache_cleanup_thread_ownership.
|
||||
cache.stop_cleanup_thread()
|
||||
|
||||
def _fetch_twice(self, real_cache, monkeypatch, ttl, elapsed):
|
||||
helper = APIHelper(cache_manager=real_cache)
|
||||
helper.set_rate_limit(0)
|
||||
helper.session.get = Mock(side_effect=[_make_response({'n': 1}),
|
||||
_make_response({'n': 2})])
|
||||
now = [1_000_000.0]
|
||||
monkeypatch.setattr('src.cache.memory_cache.time.time', lambda: now[0])
|
||||
monkeypatch.setattr('src.cache.disk_cache.time.time', lambda: now[0])
|
||||
monkeypatch.setattr('src.cache_manager.time.time', lambda: now[0])
|
||||
helper.get('https://example.com/api', cache_key='lifetime_test', cache_ttl=ttl)
|
||||
now[0] += elapsed
|
||||
return helper.get('https://example.com/api', cache_key='lifetime_test', cache_ttl=ttl)
|
||||
|
||||
def test_long_ttl_outlives_the_default_read_age(self, real_cache, monkeypatch):
|
||||
assert self._fetch_twice(real_cache, monkeypatch, ttl=3600, elapsed=1000) == {'n': 1}
|
||||
|
||||
def test_short_ttl_expires(self, real_cache, monkeypatch):
|
||||
assert self._fetch_twice(real_cache, monkeypatch, ttl=60, elapsed=120) == {'n': 2}
|
||||
|
||||
def test_request_exception_returns_none_and_caches_nothing(
|
||||
self, helper, cache):
|
||||
@@ -223,15 +261,6 @@ class TestClearCache:
|
||||
|
||||
manager.clear_cache.assert_called_once_with()
|
||||
|
||||
def test_no_pattern_falls_back_to_clear(self):
|
||||
manager = types.SimpleNamespace(clear=Mock())
|
||||
helper = APIHelper(cache_manager=manager)
|
||||
helper.set_rate_limit(0)
|
||||
|
||||
helper.clear_cache()
|
||||
|
||||
manager.clear.assert_called_once_with()
|
||||
|
||||
def test_no_pattern_manager_without_any_clear_is_noop(self):
|
||||
helper = APIHelper(cache_manager=object())
|
||||
helper.set_rate_limit(0)
|
||||
|
||||
@@ -408,6 +408,14 @@ class TestAutoEnableApMode:
|
||||
assert response.status_code == 400
|
||||
assert "auto_enable_ap_mode" not in wifi_manager.config
|
||||
|
||||
def test_a_failed_save_is_reported(self, api_v3_client, wifi_manager):
|
||||
# wifi_config.json left owned by root is the usual cause.
|
||||
wifi_manager.config = {}
|
||||
wifi_manager._save_config.return_value = False
|
||||
response = api_v3_client.post(self.URL, json={"auto_enable_ap_mode": False})
|
||||
assert response.status_code == 500
|
||||
assert response.get_json()["status"] == "error"
|
||||
|
||||
|
||||
class TestRadioEnabledAndForceAcceptIntegers:
|
||||
"""`{"enabled": 1}` / `{"enabled": 0}` used to be mishandled: the old
|
||||
|
||||
@@ -362,6 +362,3 @@ class TestPriorityIsAcceptedAndIgnored:
|
||||
rid = service.submit_fetch_request(
|
||||
"nfl", 2026, "http://example.invalid/x", cache_key="k", priority=5)
|
||||
assert service.get_result(rid).cached is True
|
||||
|
||||
def test_statistics_still_report_an_empty_queue(self, service):
|
||||
assert service.get_statistics()["queue_size"] == 0
|
||||
|
||||
@@ -180,6 +180,31 @@ def test_create_backup_manifest(project: Path, tmp_path: Path) -> None:
|
||||
assert set(manifest["contents"]) >= {"config", "secrets", "wifi", "fonts", "plugin_uploads", "plugins"}
|
||||
|
||||
|
||||
def test_manifest_version_is_the_core_release(project: Path, tmp_path: Path) -> None:
|
||||
"""Not a git sha or a truncated "ref: refs/he..." read from .git/HEAD."""
|
||||
from src import __version__
|
||||
git = project / ".git"
|
||||
git.mkdir()
|
||||
(git / "HEAD").write_text("ref: refs/heads/some-branch-that-is-not-there\n", encoding="utf-8")
|
||||
zip_path = create_backup(project, output_dir=tmp_path / "exports")
|
||||
with zipfile.ZipFile(zip_path) as zf:
|
||||
manifest = json.loads(zf.read("manifest.json"))
|
||||
assert manifest["ledmatrix_version"] == __version__
|
||||
|
||||
|
||||
def test_installed_plugins_come_from_the_configured_directory(tmp_path: Path) -> None:
|
||||
root = tmp_path / "proj"
|
||||
(root / "config").mkdir(parents=True)
|
||||
(root / "config" / "config.json").write_text(
|
||||
json.dumps({"plugin_system": {"plugins_directory": "plugins"}}), encoding="utf-8")
|
||||
plugin_dir = root / "plugins" / "dev-plugin"
|
||||
plugin_dir.mkdir(parents=True)
|
||||
(plugin_dir / "manifest.json").write_text(
|
||||
json.dumps({"id": "dev-plugin", "version": "0.3.0"}), encoding="utf-8")
|
||||
|
||||
assert [p["plugin_id"] for p in list_installed_plugins(root)] == ["dev-plugin"]
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Validate
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@@ -342,7 +342,6 @@ class TestLoadConfiguration:
|
||||
'base_odds_manager': {
|
||||
'update_interval': 100,
|
||||
'timeout': 5,
|
||||
'cache_ttl': 42,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -352,7 +351,6 @@ class TestLoadConfiguration:
|
||||
# Key/attr mismatch pin: the config key is 'timeout' but the
|
||||
# attribute is request_timeout.
|
||||
assert manager.request_timeout == 5
|
||||
assert manager.cache_ttl == 42
|
||||
|
||||
def test_get_config_raising_keeps_defaults(self, cache_manager):
|
||||
config_manager = MagicMock()
|
||||
@@ -362,4 +360,3 @@ class TestLoadConfiguration:
|
||||
|
||||
assert manager.update_interval == 3600
|
||||
assert manager.request_timeout == 5
|
||||
assert manager.cache_ttl == 1800
|
||||
|
||||
@@ -185,3 +185,35 @@ class TestLogoScale:
|
||||
def test_an_unusable_scale_is_ignored(self, logo, bad):
|
||||
helper = LogoHelper(display_width=64, display_height=32)
|
||||
assert helper.load_logo("AAA", logo, 32, 32, scale=bad).size == (32, 32)
|
||||
|
||||
def test_a_scale_the_schema_allows_is_applied(self, logo):
|
||||
"""The Scale field's maximum is honoured, not reset to 1.0."""
|
||||
from src.element_style import MAX_ELEMENT_SCALE
|
||||
helper = LogoHelper(display_width=64, display_height=32)
|
||||
big = helper.load_logo("AAA", logo, 4, 4, scale=MAX_ELEMENT_SCALE)
|
||||
assert big.size == (40, 40)
|
||||
|
||||
def test_a_scale_beyond_the_range_is_clamped(self, logo):
|
||||
from src.element_style import MAX_ELEMENT_SCALE, MIN_ELEMENT_SCALE
|
||||
helper = LogoHelper(display_width=64, display_height=32)
|
||||
assert helper.load_logo("AAA", logo, 4, 4, scale=MAX_ELEMENT_SCALE * 3).size == (40, 40)
|
||||
assert helper.load_logo("AAA", logo, 40, 40, scale=MIN_ELEMENT_SCALE / 2).size == (4, 4)
|
||||
|
||||
|
||||
class TestScaleCoercion:
|
||||
"""One range for the schema, element_scale and LogoHelper."""
|
||||
|
||||
def test_schema_bounds_are_the_clamp_bounds(self):
|
||||
from src.element_style import (MAX_ELEMENT_SCALE, MIN_ELEMENT_SCALE,
|
||||
_offset_block_from_spec)
|
||||
prop = _offset_block_from_spec("home_logo", {"scale": True})["properties"]["scale"]
|
||||
assert (prop["minimum"], prop["maximum"]) == (MIN_ELEMENT_SCALE, MAX_ELEMENT_SCALE)
|
||||
|
||||
@pytest.mark.parametrize("raw,expected", [
|
||||
(0.5, 0.5), (25, 10.0), (0.01, 0.1),
|
||||
(0, 1.0), (-2, 1.0), ("x", 1.0), (True, 1.0),
|
||||
(float("nan"), 1.0), (float("inf"), 1.0),
|
||||
])
|
||||
def test_element_scale_clamps_and_rejects(self, raw, expected):
|
||||
cfg = {"customization": {"layout": {"home_logo": {"scale": raw}}}}
|
||||
assert element_scale(cfg, "home_logo") == expected
|
||||
|
||||
@@ -124,6 +124,45 @@ class TestErrorRecording:
|
||||
assert aggregator._plugin_error_counts["plugin-a"]["ValueError"] == 2
|
||||
assert aggregator._plugin_error_counts["plugin-b"]["ValueError"] == 1
|
||||
|
||||
def test_stack_trace_recorded_outside_except_block(self):
|
||||
"""The trace comes from the exception, not from the handler in progress.
|
||||
|
||||
plugin_executor records exceptions caught on a worker thread after
|
||||
its except block has ended, where format_exc() only says
|
||||
"NoneType: None".
|
||||
"""
|
||||
def failing_plugin_update():
|
||||
raise ValueError("boom")
|
||||
|
||||
caught = []
|
||||
|
||||
def worker():
|
||||
try:
|
||||
failing_plugin_update()
|
||||
except ValueError as e:
|
||||
caught.append(e)
|
||||
|
||||
thread = threading.Thread(target=worker)
|
||||
thread.start()
|
||||
thread.join()
|
||||
|
||||
record = ErrorAggregator().record_error(caught[0], plugin_id="p")
|
||||
|
||||
assert "NoneType: None" not in record.stack_trace
|
||||
assert "failing_plugin_update" in record.stack_trace
|
||||
assert "ValueError: boom" in record.stack_trace
|
||||
|
||||
def test_record_error_leaves_caller_context_unchanged(self):
|
||||
"""LEDMatrixError context is merged into a copy of the caller's dict."""
|
||||
context = {"caller": "value"}
|
||||
error = PluginError("failed", plugin_id="p", context={"extra": 1})
|
||||
|
||||
record = ErrorAggregator().record_error(error, context=context)
|
||||
|
||||
assert context == {"caller": "value"}
|
||||
assert record.context["caller"] == "value"
|
||||
assert record.context["extra"] == 1
|
||||
|
||||
|
||||
class TestPatternDetection:
|
||||
"""Test error pattern detection."""
|
||||
|
||||
@@ -8,10 +8,14 @@ test here asserts observable behavior: returned font types, cache identity,
|
||||
fallback selection, and BDF native-size reading.
|
||||
"""
|
||||
|
||||
import json
|
||||
import shutil
|
||||
|
||||
import freetype
|
||||
import pytest
|
||||
from PIL import ImageFont
|
||||
|
||||
from src.common.font_layout import resolve_asset_path
|
||||
from src.font_manager import FontManager
|
||||
|
||||
|
||||
@@ -132,3 +136,37 @@ class TestCacheLifecycle:
|
||||
fm.reload_config({})
|
||||
assert fm.cache_generation == gen_before + 1
|
||||
assert not fm.font_cache
|
||||
|
||||
|
||||
class TestPluginFonts:
|
||||
"""plugin:// sources resolve against the plugin's own directory, which
|
||||
by default lives under plugin-repos/, not a cwd-relative plugins/."""
|
||||
|
||||
MANIFEST = {"fonts": [{"family": "bundled", "source": "plugin://fonts/Bundled.ttf"}]}
|
||||
|
||||
@staticmethod
|
||||
def _plugin_with_font(root, name="my-plugin"):
|
||||
plugin_dir = root / name
|
||||
(plugin_dir / "fonts").mkdir(parents=True)
|
||||
(plugin_dir / "manifest.json").write_text(json.dumps({"id": "my-plugin"}))
|
||||
shutil.copy(resolve_asset_path("assets/fonts/PressStart2P-Regular.ttf"),
|
||||
plugin_dir / "fonts" / "Bundled.ttf")
|
||||
return plugin_dir
|
||||
|
||||
def test_font_resolves_under_the_given_plugin_dir(self, fm, tmp_path):
|
||||
plugin_dir = self._plugin_with_font(tmp_path / "plugin-repos")
|
||||
|
||||
assert fm.register_plugin_fonts("my-plugin", self.MANIFEST, plugin_dir=plugin_dir)
|
||||
|
||||
assert fm.font_catalog["my-plugin::bundled"] == str(plugin_dir / "fonts" / "Bundled.ttf")
|
||||
font = fm.resolve_font("x.y", "bundled", 8, plugin_id="my-plugin")
|
||||
assert isinstance(font, ImageFont.FreeTypeFont)
|
||||
|
||||
def test_without_a_plugin_dir_the_configured_directory_is_searched(self, tmp_path):
|
||||
plugins_root = tmp_path / "installed"
|
||||
plugin_dir = self._plugin_with_font(plugins_root, name="ledmatrix-my-plugin")
|
||||
fm = FontManager({"plugin_system": {"plugins_directory": str(plugins_root)}})
|
||||
|
||||
assert fm.register_plugin_fonts("my-plugin", self.MANIFEST)
|
||||
|
||||
assert fm.font_catalog["my-plugin::bundled"] == str(plugin_dir / "fonts" / "Bundled.ttf")
|
||||
|
||||
@@ -133,6 +133,26 @@ class TestAssetPathsIgnoreTheWorkingDirectory:
|
||||
rel = f"assets/fonts/{FOUR_BY_SIX}"
|
||||
assert FontManager._resolve_asset_path(rel) == resolve_asset_path(rel)
|
||||
|
||||
def test_font_overrides_file_lives_in_the_install_config(self, tmp_path, monkeypatch):
|
||||
from src.font_manager import FontManager
|
||||
monkeypatch.chdir(tmp_path)
|
||||
fm = FontManager({})
|
||||
assert fm.font_overrides_file == str(PROJECT_ROOT / "config" / "font_overrides.json")
|
||||
|
||||
def test_logo_placeholder_draws_with_the_bundled_font(self, tmp_path, monkeypatch):
|
||||
import src.logo_downloader as logo_downloader
|
||||
from src.logo_downloader import LogoDownloader
|
||||
loaded = []
|
||||
|
||||
def spy(font, size, **kwargs):
|
||||
loaded.append(font)
|
||||
return load_truetype(font, size, **kwargs)
|
||||
|
||||
monkeypatch.chdir(tmp_path)
|
||||
monkeypatch.setattr(logo_downloader, "load_truetype", spy)
|
||||
assert LogoDownloader().create_placeholder_logo("AB", str(tmp_path))
|
||||
assert loaded == [str(PROJECT_ROOT / "assets" / "fonts" / PRESS_START)]
|
||||
|
||||
|
||||
class TestTheHarnessForkAgreesWithTheCore:
|
||||
"""The divergence that let the wrong rendering be blessed as golden.
|
||||
|
||||
@@ -78,3 +78,25 @@ class TestBackgroundDataServiceHeaders:
|
||||
assert 'yourusername' not in str(headers)
|
||||
finally:
|
||||
service.shutdown(wait=False)
|
||||
|
||||
|
||||
class TestResolverHeaders:
|
||||
def test_dynamic_team_resolver_sends_the_user_agent(self):
|
||||
from unittest.mock import patch
|
||||
from src.dynamic_team_resolver import DynamicTeamResolver
|
||||
DynamicTeamResolver._rankings_cache = {}
|
||||
DynamicTeamResolver._cache_timestamp = 0
|
||||
try:
|
||||
with patch('src.dynamic_team_resolver.requests.get',
|
||||
side_effect=RuntimeError("stop")) as get:
|
||||
DynamicTeamResolver().resolve_teams(["AP_TOP_5"])
|
||||
assert get.call_args.kwargs['headers']['User-Agent'] == USER_AGENT
|
||||
finally:
|
||||
DynamicTeamResolver._rankings_cache = {}
|
||||
DynamicTeamResolver._cache_timestamp = 0
|
||||
|
||||
def test_odds_manager_uses_the_shared_headers(self):
|
||||
from src.base_odds_manager import BaseOddsManager
|
||||
headers = BaseOddsManager(MagicMock()).session.headers
|
||||
for name, value in DEFAULT_HTTP_HEADERS.items():
|
||||
assert headers[name] == value
|
||||
|
||||
@@ -357,6 +357,33 @@ class TestRefreshPlaceholderTimestamp:
|
||||
assert refresh_placeholder_timestamp(tmp_path / "nope.png") is False
|
||||
|
||||
|
||||
class TestFailurePaths:
|
||||
def test_a_team_without_logos_is_a_failed_download(self, tmp_path):
|
||||
downloader = LogoDownloader()
|
||||
with patch.object(downloader, "fetch_single_team",
|
||||
return_value={"team": {"logos": []}}):
|
||||
assert downloader.download_missing_logo_for_team(
|
||||
"nfl", "1", "XYZ", tmp_path / "XYZ.png") is False
|
||||
|
||||
def test_placeholder_is_written_where_the_caller_looks(self, tmp_path):
|
||||
"""A path that is not <normalized abbreviation>.png (the plugin's own
|
||||
file naming, or an abbreviation normalize_abbreviation rewrites)
|
||||
still ends up holding the placeholder, so True means it exists."""
|
||||
logo_path = tmp_path / "TA&M.png"
|
||||
with patch.object(LogoDownloader, "download_logo", return_value=False):
|
||||
assert download_missing_logo(
|
||||
"ncaa_fb", "245", "TA&M", logo_path,
|
||||
logo_url="http://example/tamu.png") is True
|
||||
assert is_placeholder_logo(logo_path)
|
||||
assert not (tmp_path / "TAANDM.png").exists()
|
||||
|
||||
def test_placeholder_uses_the_placeholder_geometry(self, tmp_path):
|
||||
assert LogoDownloader().create_placeholder_logo("AB", str(tmp_path))
|
||||
with Image.open(tmp_path / "AB.png") as img:
|
||||
assert img.size == PLACEHOLDER_SIZE
|
||||
assert img.convert("RGBA").getpixel((0, 0)) == PLACEHOLDER_BG
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# download_logo: the download the scoreboard plugins actually use
|
||||
#
|
||||
|
||||
@@ -294,6 +294,31 @@ class TestValidateConfigFailure:
|
||||
assert result is False
|
||||
|
||||
|
||||
class TestPluginFontRegistration:
|
||||
"""A manifest's fonts block is registered against the directory the
|
||||
plugin was loaded from, which plugin:// font sources are relative to."""
|
||||
|
||||
def test_plugin_dir_is_passed_to_the_font_manager(self, temp_plugin_dir, mock_managers):
|
||||
plugin_dir = temp_plugin_dir / "test-plugin"
|
||||
plugin_dir.mkdir()
|
||||
fonts = {"fonts": [{"family": "f", "source": "plugin://f.ttf"}]}
|
||||
manifest = {"id": "test-plugin", "name": "Test Plugin",
|
||||
"entry_point": "manager.py", "class_name": "TestPlugin",
|
||||
"fonts": fonts}
|
||||
|
||||
with patch('src.common.permission_utils.ensure_directory_permissions'):
|
||||
manager = PluginManager(plugins_dir=str(temp_plugin_dir), **mock_managers)
|
||||
manager.plugin_manifests["test-plugin"] = manifest
|
||||
with patch.object(manager.plugin_loader, 'load_plugin',
|
||||
return_value=(MagicMock(), MagicMock())):
|
||||
with patch.object(manager.plugin_loader, 'find_plugin_directory',
|
||||
return_value=plugin_dir):
|
||||
manager.load_plugin("test-plugin")
|
||||
|
||||
mock_managers["font_manager"].register_plugin_fonts.assert_called_once_with(
|
||||
"test-plugin", fonts, plugin_dir=plugin_dir)
|
||||
|
||||
|
||||
class TestPluginStateOnFailure:
|
||||
"""Test that plugin state is correctly set on various failures."""
|
||||
|
||||
|
||||
@@ -63,6 +63,15 @@ class TestValidateConfig:
|
||||
assert "Missing required configuration key: display" in errors
|
||||
assert "Missing required configuration key: timezone" in errors
|
||||
|
||||
@pytest.mark.parametrize("config,expected", [
|
||||
({'timezone': 'UTC'}, "Missing required configuration key: display"),
|
||||
({'display': {}, 'timezone': 'UTC'}, "Display configuration is empty"),
|
||||
])
|
||||
def test_a_missing_display_section_is_reported_once(self, good_cache, config, expected):
|
||||
validator = StartupValidator(make_config_manager(config))
|
||||
_, errors, _ = validator.validate_all()
|
||||
assert errors == [expected]
|
||||
|
||||
def test_config_error_does_not_propagate(self, good_cache):
|
||||
mgr = make_config_manager(GOOD_CONFIG)
|
||||
mgr.load_config.side_effect = ConfigError("bad json")
|
||||
|
||||
@@ -38,6 +38,7 @@ import numpy as np
|
||||
import pytest
|
||||
from PIL import Image
|
||||
|
||||
from test._api_v3_test_helpers import api_v3_client, api_v3_module # noqa: F401
|
||||
from src.common import sync_manager
|
||||
from src.common.sync_manager import (
|
||||
DisplaySyncManager,
|
||||
@@ -878,6 +879,14 @@ class TestWriteStatusFile:
|
||||
mgr.write_status_file() # must not raise
|
||||
assert mgr.logger.debug.called
|
||||
|
||||
def test_web_status_endpoint_reads_the_file_that_was_written(self, api_v3_client):
|
||||
"""GET /sync/status reads STATUS_FILE, which lives under
|
||||
tempfile.gettempdir() -- not always /tmp."""
|
||||
mgr = make_manager(role=SyncRole.LEADER)
|
||||
mgr.write_status_file()
|
||||
response = api_v3_client.get("/api/v3/sync/status")
|
||||
assert response.get_json()["data"]["role"] == "leader"
|
||||
|
||||
|
||||
class TestStop:
|
||||
def _stub_with_sockets(self):
|
||||
|
||||
@@ -24,10 +24,13 @@ class TestTextHelper:
|
||||
assert th.font_dir == tmp_path
|
||||
assert th._font_cache == {}
|
||||
|
||||
def test_init_default_font_dir(self):
|
||||
"""Test TextHelper initialization with default font directory."""
|
||||
def test_init_default_font_dir(self, tmp_path, monkeypatch):
|
||||
"""The default is the install's assets/fonts, not a cwd-relative path."""
|
||||
from pathlib import Path
|
||||
monkeypatch.chdir(tmp_path)
|
||||
th = TextHelper()
|
||||
assert th.font_dir == pytest.importorskip("pathlib").Path("assets/fonts")
|
||||
assert th.font_dir == Path(__file__).resolve().parents[1] / "assets" / "fonts"
|
||||
assert isinstance(th.load_fonts()["score"], ImageFont.FreeTypeFont)
|
||||
|
||||
@patch('PIL.ImageFont.truetype')
|
||||
@patch('PIL.ImageFont.load_default')
|
||||
@@ -123,6 +126,17 @@ class TestTextHelper:
|
||||
def test_get_default_font_config(self, text_helper):
|
||||
"""Test getting default font configuration."""
|
||||
config = text_helper._get_default_font_config()
|
||||
|
||||
|
||||
assert isinstance(config, dict)
|
||||
assert len(config) > 0
|
||||
|
||||
def test_each_font_file_and_size_is_loaded_once(self):
|
||||
th = TextHelper()
|
||||
first = th.load_fonts()
|
||||
second = th.load_fonts()
|
||||
# Six names, three (file, size) pairs: PressStart2P at 10 and 8, 4x6 at 6.
|
||||
assert first["score"] is second["score"] is first["rank"]
|
||||
assert th.get_font_cache_stats()["cached_fonts"] == 3
|
||||
th.clear_font_cache()
|
||||
assert th.get_font_cache_stats()["cached_fonts"] == 0
|
||||
assert th.load_fonts()["score"] is not first["score"]
|
||||
|
||||
@@ -369,6 +369,26 @@ def test_default_config_has_no_saved_networks(tmp_path: Path) -> None:
|
||||
assert "saved_networks" not in json.loads(config_path.read_text())
|
||||
|
||||
|
||||
@pytest.mark.unit
|
||||
def test_save_config_reports_a_failed_write(manager: WiFiManager, tmp_path: Path) -> None:
|
||||
# A directory where the file should be: every write to it fails, as one
|
||||
# to a root-owned wifi_config.json does for the web user.
|
||||
blocked = tmp_path / "blocked.json"
|
||||
blocked.mkdir()
|
||||
manager.config_path = blocked
|
||||
|
||||
assert manager._save_config() is False
|
||||
assert list(tmp_path.glob(".blocked.json.tmp.*")) == []
|
||||
|
||||
|
||||
@pytest.mark.unit
|
||||
def test_save_config_round_trips(manager: WiFiManager) -> None:
|
||||
manager.config["auto_enable_ap_mode"] = False
|
||||
|
||||
assert manager._save_config() is True
|
||||
assert json.loads(manager.config_path.read_text())["auto_enable_ap_mode"] is False
|
||||
|
||||
|
||||
@pytest.mark.unit
|
||||
def test_connecting_does_not_store_the_password(manager: WiFiManager) -> None:
|
||||
commands = []
|
||||
@@ -389,3 +409,77 @@ def test_connecting_does_not_store_the_password(manager: WiFiManager) -> None:
|
||||
"the new-connection path was not reached"
|
||||
assert "hunter22" not in json.dumps(manager.config)
|
||||
assert "hunter22" not in manager.config_path.read_text()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 7. Disconnect takes the saved profile down
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _profile_nmcli(profiles: dict):
|
||||
"""A fake subprocess.run for `nmcli connection show` over ``profiles``
|
||||
(profile name -> SSID), recording every command it is given."""
|
||||
commands = []
|
||||
|
||||
def fake_run(cmd, *args, **kwargs):
|
||||
commands.append(cmd)
|
||||
if cmd == ["nmcli", "-t", "-f", "NAME,TYPE", "connection", "show"]:
|
||||
lines = [name.replace(":", "\\:") + ":802-11-wireless" for name in profiles]
|
||||
lines.append("Wired connection 1:802-3-ethernet")
|
||||
return _ok(stdout="\n".join(lines) + "\n")
|
||||
if cmd[:4] == ["nmcli", "-g", "802-11-wireless.ssid", "connection"]:
|
||||
return _ok(stdout=profiles.get(cmd[-1], "") + "\n")
|
||||
if cmd[:3] == ["nmcli", "connection", "show"]:
|
||||
return _ok() if cmd[3] in profiles else _fail()
|
||||
# nmcli rejects 802-11-wireless.ssid as a `connection show -f` column.
|
||||
if "802-11-wireless.ssid" in cmd:
|
||||
return _fail(stderr="Error: invalid field '802-11-wireless.ssid'")
|
||||
return _ok()
|
||||
|
||||
return fake_run, commands
|
||||
|
||||
|
||||
@pytest.mark.unit
|
||||
def test_find_profile_for_ssid_matches_by_ssid_not_name(manager: WiFiManager) -> None:
|
||||
fake_run, _ = _profile_nmcli({"home: upstairs": "HomeNet", "Office": "OfficeNet"})
|
||||
with patch("src.wifi_manager.subprocess.run", side_effect=fake_run):
|
||||
assert manager._find_profile_for_ssid("HomeNet") == "home: upstairs"
|
||||
assert manager._find_profile_for_ssid("OfficeNet") == "Office"
|
||||
assert manager._find_profile_for_ssid("Elsewhere") is None
|
||||
|
||||
|
||||
@pytest.mark.unit
|
||||
def test_disconnect_takes_the_profile_down(manager: WiFiManager) -> None:
|
||||
from src.wifi_manager import WiFiStatus
|
||||
|
||||
fake_run, commands = _profile_nmcli({"Home profile": "HomeNet"})
|
||||
with patch("src.wifi_manager.subprocess.run", side_effect=fake_run), \
|
||||
patch("src.wifi_manager.time.sleep"), \
|
||||
patch.object(manager, "get_wifi_status",
|
||||
return_value=WiFiStatus(connected=True, ssid="HomeNet")):
|
||||
ok, _ = manager.disconnect_from_network(skip_ap_check=True)
|
||||
|
||||
assert ok
|
||||
assert ["nmcli", "connection", "down", "Home profile"] in commands
|
||||
assert ["nmcli", "device", "disconnect", "wlan0"] in commands
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 8. The nmcli Wi-Fi list parser both scan paths share
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.mark.unit
|
||||
def test_nmcli_wifi_list_parsing() -> None:
|
||||
out = (
|
||||
"HomeNet:40:WPA2:2437 MHz\n"
|
||||
"Cafe:80::5180 MHz\n"
|
||||
"HomeNet:90:WPA2:5180 MHz\n" # duplicate SSID: first line wins
|
||||
":70:WPA2:2412 MHz\n" # hidden network
|
||||
"Broken:notanumber:WPA2:2412 MHz\n"
|
||||
"Modern:60:WPA3 SAE:5745 MHz\n"
|
||||
)
|
||||
networks = WiFiManager._parse_nmcli_wifi_list(out)
|
||||
assert [(n.ssid, n.signal, n.security, n.frequency) for n in networks] == [
|
||||
("Cafe", 80, "open", 5180.0),
|
||||
("Modern", 60, "wpa3", 5745.0),
|
||||
("HomeNet", 40, "wpa2", 2437.0),
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user