mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-07 19:58:08 +00:00
* ci: run the whole test tree and make the plugin-safety job assert something real The unit-tests CI job ran an explicit 24-file allowlist that had rotted: 63 of 90 test files (display, vegas, store manager, web API, web_interface) never ran on a PR. The job now runs all of test/ (minus test/plugins, which the plugin-safety job owns) so new test files are enrolled by default and any exclusion needs a visible, commented --ignore. The plugin-safety job was a green no-op: plugins/ is empty in CI, so every test skipped with 'Manifest not found'. It now renders a bundled deterministic fixture plugin (test/fixtures/plugins/ci-fixture-plugin, golden images included for all 8 default sizes) via LEDMATRIX_PLUGINS_DIR, and sets LEDMATRIX_REQUIRE_PLUGINS=1 so discovering zero plugins fails loudly instead of skipping green. The per-plugin suites document that they target dev machines with real plugins installed. Coverage is now measured and enforced in exactly one place — the CI unit-tests step (--cov=src --cov=web_interface --cov-fail-under=45, from a measured 47% baseline). pytest.ini previously declared --cov-fail-under=30 but CI always passed --no-cov, so the gate had never run anywhere; local pytest is now coverage-free and fast. Enabling the 63 unenrolled files surfaced three cases of test rot, fixed here: test_display_controller_vegas_tick.py could not collect without the hardware rgbmatrix module (now uses the emulator convention), the state-reconciliation unrecoverable-cache tests broke when production added the is_plugin_uninstalled tombstone check (bare Mock returned truthy), and test_get_system_status assumed the optional psutil dependency (now installed via requirements-test.txt and guarded by importorskip). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh * test: replace can't-fail tests with real assertions test_font_manager.py was 5 of 6 tests shaped as 'try: call(); assert True / except: assert True' — running in CI while unable to fail on any regression. Rewritten against the real FontManager API and the bundled assets/fonts: returned font types, cache-hit identity, distinct entries per size, default-font fallback for unknown families and corrupt files (recorded in failed_loads), BDF native-size reading, text measurement, and cache lifecycle. test_display_manager.py's test_draw_text ended in 'assert True'; it now renders onto a known-black canvas and asserts pixels were actually lit — which required un-breaking the fixture's freetype MagicMock so draw_text's isinstance check doesn't silently swallow the draw. test_display_controller.py carried a permanently-skipped test whose skip reason already declared it redundant; deleted. Both display test files now set EMULATOR=true before importing display_manager (the same convention as test_display_dirty_tracking.py) so they collect standalone instead of depending on which test module imports display_manager first. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh * test: cover the untested fragile logic (compatibility gate, secrets, config merges, durations, skin cards) New unit tests for pure or filesystem-only logic that previously had zero direct coverage: - test_compatibility.py: the semver install gate (parse_semver suffix handling, every range operator, TRUSTWORTHY_FLOOR behavior for cores reporting untrustworthy versions, 'more restrictive wins', and the malformed-manifest shapes that used to raise). - test/web_interface/test_secret_helpers.py: the canonical x-secret helpers — find/separate/mask/remove, array-item secrets, no input mutation, and a separate->recombine round-trip. - test/web_interface/test_api_v3_helpers.py: the module-level helpers behind the plugin config save endpoint (_is_plugin_update_available, _coerce_to_bool including the int==1 quirk, deep_merge including its shared-subtree shallowness, _parse_form_value, dotted-key-aware _get_schema_property/_set_nested_value). - test_base_plugin_duration.py: get_display_duration's full coercion ladder (instance attr -> config -> 15.0), including the bool-is-int quirk where display_duration=True means one second. - test_config_manager_secrets.py: the secrets round-trip — deep-merge on load, strip on save, group pruning, the load fast path — and two characterized sharp edges marked SUSPECTED BUG: an unreadable secrets file at save time writes secrets into config.json in plaintext, and a same-mtime-same-size content swap is served stale. - test_schema_manager_merge.py: merge_with_defaults branch behavior (None replacement vs falsey preservation, dict-vs-scalar mismatches, arrays replaced wholesale, defaults never mutated). - test_skin_system.py (extended): render_skin_card shares _render_game's 3-strike counter but never resets it on success — the asymmetry is pinned in both directions, along with card fallthrough and the disable interaction between the two paths. Suspected bugs are characterized, not fixed — each carries a comment so a future behavior change is deliberate rather than accidental. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh * test: add drift guards for cross-file contracts Three guard suites that pin contracts spanning multiple files, where one side changing unilaterally breaks the other silently: - test_version_comparison_consistency.py: the repo's four version comparators (compatibility.parse_semver, api_v3's packaging-based _is_plugin_update_available, store_manager update_plugin's raw string equality, skin_runtime._major) answer differently on the same inputs. A table pins each one's verdict; update_plugin is driven through its real code path to show the SUSPECTED BUGs: 'v1.2.0' vs '1.2.0' triggers a full reinstall the UI calls unnecessary, and a locally-ahead plugin gets downgraded. A pairwise-ordering check keeps parse_semver agreeing with packaging on plain X.Y.Z. - test/web_interface/test_secret_separation_parity.py: api_v3.py carries three inline copies of find_secret_fields/separate_secrets that lack the canonical module's array-item support. The copy count is asserted exact (it may only go down; new copies must import src/web_interface/secret_helpers), the missing-array-support gap is asserted so it can't grow silently, and the canonical behavior that migration will adopt is documented executably. - test_discovery_path_contract.py: the three 'where is plugin X' resolvers (PluginManager discovery, StoreManager._find_plugin_path, SchemaManager.get_schema_path) agree on the configured directory, and their divergent fallback chains are characterized. Also pins the .standalone-backup- naming contract shared by store rollback and discovery, and _resolve_skin_target's path-traversal rejection. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh * test: address review feedback — fixture lifecycle, test names, ClassVar - ci-fixture-plugin: call display_manager.clear() before rendering (per plugin guidelines — the fixture should model a well-behaved plugin), add a class docstring, and document why Pillow is deliberately not pinned in its requirements.txt (core dependency; harness installs nothing). - Rename two tests whose names contradicted their assertions: test_unparseable_core_version_is_compatible -> test_unparseable_core_with_high_floor_is_blocked, and test_unreadable_secrets_file... -> test_corrupt_secrets_file... - Annotate TestGetSchemaProperty.SCHEMA as ClassVar (RUF012). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh * ci: allow manual test.yml runs via workflow_dispatch Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh * fix: unify version comparison, refuse secret-leaking saves, reset skin strikes on card success Fixes the three suspected bugs this PR's characterization tests pinned, flipping those tests to assert the corrected behavior: - plugins/store: ONE shared update comparator. New compatibility.is_update_available() (PEP 440 via packaging) is now used by both the web UI's update badge (api_v3._is_plugin_update_available is a thin alias) and store_manager.update_plugin's reinstall decision. Previously update_plugin used raw string equality: 'v1.2.0' vs '1.2.0' triggered a full reinstall the UI called unnecessary, and a locally- ahead plugin (2.0.0 installed, registry 1.9.0) was silently DOWNGRADED. Now equivalent spellings skip the reinstall and locally-ahead versions are never downgraded; unparseable versions still reconcile by reinstalling from the registry. - config: save_config and save_config_atomic now refuse (ConfigError) when config_secrets.json exists but cannot be loaded. Both previously proceeded without stripping, writing the merged secrets into config.json in plaintext. The shared _load_secrets_for_save() helper raises with an actionable message instead; a missing secrets file is still fine (nothing to strip), and _migrate_config's catch-all keeps boot resilient. - skins: render_skin_card resets _skin_failures on both success paths (vegas card returned, or mode renderer handled), mirroring _render_game. Transient card failures no longer accumulate across a session until they permanently disable a working skin. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh * fix: harden shared comparator edges from review - is_update_available: reject truthy non-string versions (a malformed manifest can carry a number; packaging raises TypeError on those) by surfacing the mismatch instead of raising. - store_manager.update_plugin: drop the truthiness gate around the comparator so a missing version on either side follows the shared 'no update' verdict, keeping the store consistent with the UI badge; a missing manifest still uses the reinstall recovery path. - config_manager._load_secrets_for_save: catch only expected read/parse failures (OSError/ValueError/RecursionError) so implementation bugs propagate as themselves, and log with traceback. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh --------- Co-authored-by: Claude <noreply@anthropic.com>
240 lines
10 KiB
Python
240 lines
10 KiB
Python
import os
|
|
import pytest
|
|
from unittest.mock import MagicMock, patch
|
|
from PIL import ImageDraw
|
|
|
|
# display_manager imports the hardware rgbmatrix module at import time unless
|
|
# EMULATOR=true. Use the emulator (same convention as
|
|
# test_display_dirty_tracking.py) so this file collects standalone instead of
|
|
# relying on collection order — the tests below patch RGBMatrix/
|
|
# RGBMatrixOptions explicitly, so the underlying binding doesn't matter here.
|
|
os.environ.setdefault("EMULATOR", "true")
|
|
|
|
from src.display_manager import DisplayManager
|
|
|
|
@pytest.fixture
|
|
def mock_rgb_matrix():
|
|
"""Mock the rgbmatrix library."""
|
|
with patch('src.display_manager.RGBMatrix') as mock_matrix, \
|
|
patch('src.display_manager.RGBMatrixOptions') as mock_options, \
|
|
patch('src.display_manager.freetype'):
|
|
|
|
# Setup matrix instance mock
|
|
matrix_instance = MagicMock()
|
|
matrix_instance.width = 128
|
|
matrix_instance.height = 32
|
|
matrix_instance.CreateFrameCanvas.return_value = MagicMock()
|
|
matrix_instance.Clear = MagicMock()
|
|
matrix_instance.SetImage = MagicMock()
|
|
mock_matrix.return_value = matrix_instance
|
|
|
|
yield {
|
|
'matrix_class': mock_matrix,
|
|
'options_class': mock_options,
|
|
'matrix_instance': matrix_instance
|
|
}
|
|
|
|
class TestDisplayManagerInitialization:
|
|
"""Test DisplayManager initialization."""
|
|
|
|
def test_init_hardware_mode(self, test_config, mock_rgb_matrix):
|
|
"""Test initialization in hardware mode."""
|
|
# Ensure EMULATOR env var is not set
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(test_config)
|
|
|
|
assert dm.width == 128
|
|
assert dm.height == 32
|
|
assert dm.matrix is not None
|
|
|
|
# Verify options were set correctly
|
|
mock_rgb_matrix['options_class'].assert_called()
|
|
options = mock_rgb_matrix['options_class'].return_value
|
|
assert options.rows == 32
|
|
assert options.cols == 64
|
|
assert options.chain_length == 2
|
|
|
|
def test_init_emulator_mode(self, test_config):
|
|
"""Test initialization in emulator mode."""
|
|
# Set EMULATOR env var and patch the import
|
|
with patch.dict('os.environ', {'EMULATOR': 'true'}), \
|
|
patch('src.display_manager.RGBMatrix') as mock_matrix, \
|
|
patch('src.display_manager.RGBMatrixOptions') as mock_options:
|
|
|
|
# Setup matrix instance
|
|
matrix_instance = MagicMock()
|
|
matrix_instance.width = 128
|
|
matrix_instance.height = 32
|
|
mock_matrix.return_value = matrix_instance
|
|
|
|
dm = DisplayManager(test_config)
|
|
|
|
assert dm.width == 128
|
|
assert dm.height == 32
|
|
mock_matrix.assert_called()
|
|
|
|
|
|
class TestDisplayManagerDrawing:
|
|
"""Test drawing operations."""
|
|
|
|
def test_clear(self, test_config, mock_rgb_matrix):
|
|
"""Test clear operation."""
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(test_config)
|
|
dm.clear()
|
|
# clear() calls Clear() multiple times (offscreen_canvas, current_canvas, matrix)
|
|
assert dm.matrix.Clear.called
|
|
|
|
def test_draw_text(self, test_config, mock_rgb_matrix):
|
|
"""Text drawn through draw_text must actually light pixels."""
|
|
from PIL import Image, ImageDraw, ImageFont
|
|
import src.display_manager as dm_mod
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
DisplayManager._instance = None
|
|
dm = DisplayManager(test_config, suppress_test_pattern=True)
|
|
# The fixture replaces the module's freetype with a MagicMock,
|
|
# which breaks draw_text's isinstance(font, freetype.Face) check
|
|
# (and silently swallows the draw). Give the mock a real class so
|
|
# isinstance works and the PIL path is taken.
|
|
dm_mod.freetype.Face = type("_FakeFace", (), {})
|
|
# Start from a known-black canvas so the assertion below can only
|
|
# pass if draw_text itself lit something.
|
|
dm.image = Image.new('RGB', (dm.width, dm.height))
|
|
dm.draw = ImageDraw.Draw(dm.image)
|
|
|
|
dm.draw_text("Test", 0, 0, font=ImageFont.load_default())
|
|
|
|
assert dm.image.convert("L").getbbox() is not None, \
|
|
"draw_text lit no pixels"
|
|
|
|
def test_draw_image(self, test_config, mock_rgb_matrix):
|
|
"""Test image drawing."""
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(test_config)
|
|
|
|
# DisplayManager doesn't have draw_image method
|
|
# It uses SetImage on canvas in update_display()
|
|
# Just verify DisplayManager can handle image operations
|
|
from PIL import Image
|
|
test_image = Image.new('RGB', (64, 32))
|
|
dm.image = test_image
|
|
dm.draw = ImageDraw.Draw(dm.image)
|
|
|
|
# Verify image was set
|
|
assert dm.image is not None
|
|
|
|
|
|
class TestDisplayManagerResourceManagement:
|
|
"""Test resource management."""
|
|
|
|
def test_cleanup(self, test_config, mock_rgb_matrix):
|
|
"""Test cleanup operation."""
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(test_config)
|
|
dm.cleanup()
|
|
|
|
dm.matrix.Clear.assert_called()
|
|
|
|
|
|
class TestDisplayManagerDoubleSided:
|
|
"""Double-sided mode: render once at logical size, tile across the chain."""
|
|
|
|
def _config(self, **double_sided):
|
|
"""Build a config (physical 128x32) with the given double_sided block."""
|
|
return {
|
|
'display': {
|
|
'hardware': {
|
|
'rows': 32, 'cols': 64, 'chain_length': 2, 'parallel': 1,
|
|
'hardware_mapping': 'adafruit-hat-pwm', 'brightness': 90,
|
|
},
|
|
'runtime': {'gpio_slowdown': 2},
|
|
'double_sided': double_sided,
|
|
},
|
|
'timezone': 'UTC',
|
|
'plugin_system': {'plugins_directory': 'plugins'},
|
|
}
|
|
|
|
def _captured_physical(self, mock_rgb_matrix):
|
|
"""Return the image handed to the canvas on the last update_display()."""
|
|
canvas = mock_rgb_matrix['matrix_instance'].CreateFrameCanvas.return_value
|
|
return canvas.SetImage.call_args[0][0]
|
|
|
|
def test_horizontal_reports_logical_dimensions(self, mock_rgb_matrix):
|
|
"""Plugins see the per-screen size, not the full physical chain."""
|
|
DisplayManager._instance = None
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(self._config(enabled=True, copies=2, axis='horizontal'),
|
|
suppress_test_pattern=True)
|
|
# Physical chain is 128x32; two side-by-side copies -> logical 64x32.
|
|
assert dm.matrix.width == 64
|
|
assert dm.matrix.height == 32
|
|
assert (dm.width, dm.height) == (64, 32)
|
|
assert dm.image.size == (64, 32)
|
|
|
|
def test_horizontal_tiles_image_across_chain(self, mock_rgb_matrix):
|
|
"""The logical screen is duplicated left/right into a full-chain frame."""
|
|
from PIL import Image
|
|
DisplayManager._instance = None
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(self._config(enabled=True, copies=2, axis='horizontal'),
|
|
suppress_test_pattern=True)
|
|
logical = Image.new('RGB', (64, 32), (0, 0, 0))
|
|
logical.putpixel((5, 5), (255, 0, 0))
|
|
dm.image = logical
|
|
dm.update_display()
|
|
|
|
physical = self._captured_physical(mock_rgb_matrix)
|
|
assert physical.size == (128, 32)
|
|
assert physical.getpixel((5, 5)) == (255, 0, 0)
|
|
assert physical.getpixel((69, 5)) == (255, 0, 0) # copy shifted +64
|
|
|
|
def test_vertical_axis_tiles_stacked(self, mock_rgb_matrix):
|
|
"""Vertical axis stacks copies (for panels on parallel outputs)."""
|
|
from PIL import Image
|
|
DisplayManager._instance = None
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(self._config(enabled=True, copies=2, axis='vertical'),
|
|
suppress_test_pattern=True)
|
|
# 128x32 split vertically -> logical 128x16.
|
|
assert (dm.matrix.width, dm.matrix.height) == (128, 16)
|
|
logical = Image.new('RGB', (128, 16), (0, 0, 0))
|
|
logical.putpixel((10, 3), (0, 255, 0))
|
|
dm.image = logical
|
|
dm.update_display()
|
|
|
|
physical = self._captured_physical(mock_rgb_matrix)
|
|
assert physical.size == (128, 32)
|
|
assert physical.getpixel((10, 3)) == (0, 255, 0)
|
|
assert physical.getpixel((10, 19)) == (0, 255, 0) # copy shifted +16
|
|
|
|
def test_indivisible_dimension_disables_mode(self, mock_rgb_matrix):
|
|
"""A physical size that doesn't divide evenly falls back to single."""
|
|
DisplayManager._instance = None
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(self._config(enabled=True, copies=3, axis='horizontal'),
|
|
suppress_test_pattern=True)
|
|
assert dm._double_sided is None # 128 % 3 != 0
|
|
assert dm.matrix.width == 128
|
|
assert dm.image.size == (128, 32)
|
|
|
|
def test_disabled_blits_logical_image_unchanged(self, mock_rgb_matrix):
|
|
"""With the feature off, the rendered image is sent through untouched."""
|
|
from PIL import Image
|
|
DisplayManager._instance = None
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(self._config(enabled=False), suppress_test_pattern=True)
|
|
assert dm._double_sided is None
|
|
img = Image.new('RGB', (128, 32))
|
|
dm.image = img
|
|
dm.update_display()
|
|
assert self._captured_physical(mock_rgb_matrix) is img
|
|
|
|
def test_brightness_write_forwards_through_proxy(self, mock_rgb_matrix):
|
|
"""Setting brightness via the proxy reaches the real matrix."""
|
|
DisplayManager._instance = None
|
|
with patch.dict('os.environ', {'EMULATOR': 'false'}):
|
|
dm = DisplayManager(self._config(enabled=True, copies=2, axis='horizontal'),
|
|
suppress_test_pattern=True)
|
|
assert dm.set_brightness(70) is True
|
|
assert mock_rgb_matrix['matrix_instance'].brightness == 70
|