mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-05 06:45:09 +00:00
display.vegas_scroll.live_in_ticker now defaults to true: through a live game the marquee keeps running and the live scoreboard takes extra turns in it -- its cards updating in place while they scroll -- instead of the ticker giving way to the full-screen scoreboard. The new default would reach nobody on its own: every existing config holds an explicit false copied from the template (there was no control for it), and the template merge only adds missing keys. ConfigManager therefore turns a stored false on once, with a backup, and records live_in_ticker_migrated so a false chosen afterwards stays. The marker is never in the template. A "Keep live games in the ticker" checkbox under Vegas mode sets it. Tests that pin the full-screen takeover now say live_in_ticker=false. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
301 lines
13 KiB
Python
301 lines
13 KiB
Python
"""Tests that live content can take extra turns inside the Vegas ticker.
|
|
|
|
Vegas was a strict round robin -- every plugin exactly once per cycle -- and
|
|
live content did not appear in it at all, because the display controller
|
|
refused to run the ticker while anything was live. With a dozen plugins
|
|
enabled that left a live score either absent or minutes stale.
|
|
|
|
Two things change. `live_in_ticker` keeps the marquee running instead of
|
|
yielding to a full-screen takeover (on by default since 3.8.0), and the
|
|
rotation is expanded by Smooth Weighted Round-Robin so a weighted plugin gets
|
|
several slots per cycle, spaced through it rather than clumped.
|
|
|
|
Weights are per plugin, not per game: a scoreboard showing four live games
|
|
still occupies one slot at a time and rotates its own games within it.
|
|
"""
|
|
|
|
from unittest.mock import Mock
|
|
|
|
import pytest
|
|
|
|
from src.vegas_mode.config import VegasModeConfig
|
|
from src.vegas_mode.stream_manager import StreamManager
|
|
|
|
|
|
class FakePlugin:
|
|
"""A plugin that can fail in each place independently.
|
|
|
|
hook_raises and live_raises are separate because they mean different
|
|
things: a broken weight calculation should still leave the core's own
|
|
live-content check usable, while a plugin that cannot answer whether it is
|
|
live at all has nothing left to fall back on.
|
|
"""
|
|
|
|
def __init__(self, live=False, declared=None, raises=False,
|
|
hook_raises=False, live_raises=False):
|
|
self._live = live
|
|
self._declared = declared
|
|
self._hook_raises = hook_raises or raises
|
|
self._live_raises = live_raises or raises
|
|
self.enabled = True
|
|
|
|
def has_live_priority(self):
|
|
if self._live_raises:
|
|
raise RuntimeError("cannot say whether I am live")
|
|
return self._live
|
|
|
|
def has_live_content(self):
|
|
return self._live
|
|
|
|
def get_vegas_priority_weight(self):
|
|
if self._hook_raises:
|
|
raise RuntimeError("weight calculation blew up")
|
|
return self._declared
|
|
|
|
|
|
def _manager(plugins, **cfg):
|
|
config = VegasModeConfig(live_in_ticker=cfg.pop('live_in_ticker', True), **cfg)
|
|
pm = Mock()
|
|
pm.plugins = plugins
|
|
sm = StreamManager.__new__(StreamManager)
|
|
sm.config = config
|
|
sm.plugin_manager = pm
|
|
return sm
|
|
|
|
|
|
def _counts(schedule):
|
|
return {p: schedule.count(p) for p in set(schedule)}
|
|
|
|
|
|
def _max_gap(schedule, plugin_id):
|
|
"""Largest gap between consecutive appearances, wrapping around."""
|
|
at = [i for i, p in enumerate(schedule) if p == plugin_id]
|
|
if len(at) < 2:
|
|
return len(schedule)
|
|
gaps = [b - a for a, b in zip(at, at[1:])]
|
|
gaps.append(len(schedule) - at[-1] + at[0])
|
|
return max(gaps)
|
|
|
|
|
|
class TestWeightsComeFromTheRightPlace:
|
|
def test_a_quiet_plugin_gets_one_slot(self):
|
|
sm = _manager({'clock': FakePlugin()})
|
|
assert sm._plugin_weight('clock') == 1
|
|
|
|
def test_live_content_earns_the_configured_weight(self):
|
|
sm = _manager({'mlb': FakePlugin(live=True)}, live_weight=4)
|
|
assert sm._plugin_weight('mlb') == 4
|
|
|
|
def test_a_plugin_may_answer_for_itself(self):
|
|
# The only route for favorite-team awareness: the core can see that a
|
|
# game is live, not whose.
|
|
sm = _manager({'mlb': FakePlugin(live=True, declared=7)}, live_weight=3)
|
|
assert sm._plugin_weight('mlb') == 7
|
|
|
|
def test_declaring_none_defers_to_the_core(self):
|
|
sm = _manager({'mlb': FakePlugin(live=True, declared=None)}, live_weight=3)
|
|
assert sm._plugin_weight('mlb') == 3
|
|
|
|
def test_a_declared_weight_is_clamped(self):
|
|
sm = _manager({'a': FakePlugin(declared=99), 'b': FakePlugin(declared=0)})
|
|
assert sm._plugin_weight('a') == 10
|
|
assert sm._plugin_weight('b') == 1
|
|
|
|
def test_a_plugin_that_raises_everywhere_weighs_one(self):
|
|
sm = _manager({'bad': FakePlugin(raises=True)})
|
|
assert sm._plugin_weight('bad') == 1
|
|
|
|
def test_a_broken_hook_still_earns_the_live_boost(self):
|
|
# The hook is only how a plugin asks for *more* than live_weight.
|
|
# Losing it should cost the favorite distinction, not the live boost:
|
|
# has_live_priority/has_live_content are separate and still work.
|
|
sm = _manager({'mlb': FakePlugin(live=True, hook_raises=True)},
|
|
live_weight=4)
|
|
assert sm._plugin_weight('mlb') == 4
|
|
|
|
def test_a_broken_hook_on_a_quiet_plugin_weighs_one(self):
|
|
sm = _manager({'clock': FakePlugin(live=False, hook_raises=True)},
|
|
live_weight=4)
|
|
assert sm._plugin_weight('clock') == 1
|
|
|
|
def test_a_plugin_that_cannot_say_whether_it_is_live_weighs_one(self):
|
|
# Nothing left to fall back on, so no boost.
|
|
sm = _manager({'mlb': FakePlugin(live=True, live_raises=True)},
|
|
live_weight=4)
|
|
assert sm._plugin_weight('mlb') == 1
|
|
|
|
def test_an_unknown_plugin_weighs_one(self):
|
|
assert _manager({})._plugin_weight('ghost') == 1
|
|
|
|
|
|
class TestTheSchedule:
|
|
def test_nothing_weighted_leaves_the_order_untouched(self):
|
|
order = ['weather', 'clock', 'news']
|
|
sm = _manager({p: FakePlugin() for p in order})
|
|
assert sm._apply_priority_weights(order) == order
|
|
|
|
def test_off_by_default_the_order_is_untouched(self):
|
|
order = ['weather', 'mlb', 'news']
|
|
sm = _manager({'weather': FakePlugin(), 'mlb': FakePlugin(live=True),
|
|
'news': FakePlugin()}, live_in_ticker=False, live_weight=3)
|
|
assert sm._apply_priority_weights(order) == order
|
|
|
|
def test_a_live_plugin_takes_its_share_of_slots(self):
|
|
order = ['weather', 'mlb', 'news', 'clock']
|
|
sm = _manager({'weather': FakePlugin(), 'mlb': FakePlugin(live=True),
|
|
'news': FakePlugin(), 'clock': FakePlugin()},
|
|
live_weight=3)
|
|
schedule = sm._apply_priority_weights(order)
|
|
counts = _counts(schedule)
|
|
assert counts['mlb'] == 3, counts
|
|
assert counts['weather'] == counts['news'] == counts['clock'] == 1, counts
|
|
assert len(schedule) == 6
|
|
|
|
def test_every_plugin_still_appears(self):
|
|
# A boost must not starve anything out of the cycle.
|
|
order = ['a', 'b', 'c', 'd', 'e', 'f']
|
|
plugins = {p: FakePlugin() for p in order}
|
|
plugins['a'] = FakePlugin(live=True, declared=10)
|
|
sm = _manager(plugins)
|
|
schedule = sm._apply_priority_weights(order)
|
|
assert set(schedule) == set(order), set(order) - set(schedule)
|
|
|
|
def test_nothing_doubles_across_the_cycle_seam(self):
|
|
# The strip loops, so the last slot neighbours the first. Smooth
|
|
# Weighted Round-Robin schedules the heaviest item first and often
|
|
# last too, which put the one clump the algorithm exists to avoid at
|
|
# the one place a within-cycle check cannot see.
|
|
order = ['baseball', 'weather', 'geochron', 'flights', 'stocks',
|
|
'oftheday', 'youtube', 'stocknews', 'leaderboard',
|
|
'countdown', 'odds', 'f1', 'football', 'music']
|
|
plugins = {p: FakePlugin() for p in order}
|
|
plugins['baseball'] = FakePlugin(live=True, declared=5)
|
|
plugins['football'] = FakePlugin(live=True, declared=3)
|
|
schedule = _manager(plugins)._apply_priority_weights(order)
|
|
|
|
n = len(schedule)
|
|
doubles = [schedule[i] for i in range(n)
|
|
if schedule[i] == schedule[(i + 1) % n]]
|
|
assert not doubles, "%r repeats across the seam in %r" % (doubles, schedule)
|
|
|
|
def test_the_seam_repair_keeps_every_slot(self):
|
|
order = ['a', 'b', 'c', 'd', 'e', 'f']
|
|
plugins = {p: FakePlugin() for p in order}
|
|
plugins['a'] = FakePlugin(live=True, declared=4)
|
|
schedule = _manager(plugins)._apply_priority_weights(order)
|
|
assert _counts(schedule)['a'] == 4, _counts(schedule)
|
|
assert sorted(schedule) == sorted(
|
|
['a'] * 4 + ['b', 'c', 'd', 'e', 'f']), schedule
|
|
|
|
def test_the_repair_uses_the_widest_gap(self):
|
|
# Moving the trailing repeat into the first slot that merely fits
|
|
# undoes the spacing: on a 28-slot rotation that turned a gap of 7
|
|
# into a gap of 2, which is more clumped than the seam ever was.
|
|
order = ['a'] + ['p%d' % i for i in range(13)]
|
|
plugins = {p: FakePlugin() for p in order}
|
|
plugins['a'] = FakePlugin(live=True, declared=4)
|
|
schedule = _manager(plugins)._apply_priority_weights(order)
|
|
at = [i for i, p in enumerate(schedule) if p == 'a']
|
|
gaps = [b - a for a, b in zip(at, at[1:])]
|
|
gaps.append(len(schedule) - at[-1] + at[0])
|
|
ideal = len(schedule) / len(at)
|
|
assert min(gaps) >= ideal / 2, "gaps %r for ideal %.1f" % (gaps, ideal)
|
|
|
|
def test_an_unavoidable_double_is_left_alone(self):
|
|
# Five of seven slots are the same plugin, so it must neighbour
|
|
# itself. Better to schedule it than to refuse or loop forever.
|
|
order = ['a', 'b', 'c']
|
|
plugins = {p: FakePlugin() for p in order}
|
|
plugins['a'] = FakePlugin(live=True, declared=5)
|
|
schedule = _manager(plugins)._apply_priority_weights(order)
|
|
assert _counts(schedule) == {'a': 5, 'b': 1, 'c': 1}, _counts(schedule)
|
|
assert set(schedule) == {'a', 'b', 'c'}
|
|
|
|
def test_the_repair_never_creates_a_new_double(self):
|
|
# The first version guarded the slot the repeated value moves *into*
|
|
# but not the one the displaced element lands in, so this traded the
|
|
# seam duplicate for a fresh one and came back ending ['x', 'x'].
|
|
sm = _manager({})
|
|
out = sm._unclump_seam(['a', 'b', 'c', 'd', 'x', 'y', 'x', 'a'])
|
|
n = len(out)
|
|
doubles = [out[i] for i in range(n) if out[i] == out[(i + 1) % n]]
|
|
assert not doubles, "%r in %r" % (doubles, out)
|
|
assert sorted(out) == sorted(['a', 'b', 'c', 'd', 'x', 'y', 'x', 'a'])
|
|
|
|
def test_the_last_two_slots_are_a_usable_swap(self):
|
|
# Reasoning about indices said this candidate was unsafe because
|
|
# schedule[j] is schedule[-2]; after the swap its neighbour is the
|
|
# repeated value, not itself. Refusing it left the only repair this
|
|
# schedule has on the table.
|
|
assert _manager({})._unclump_seam(['a', 'b', 'c', 'a']) == ['a', 'b', 'a', 'c']
|
|
|
|
def test_no_seam_schedule_is_ever_made_worse(self):
|
|
import random
|
|
sm = _manager({})
|
|
random.seed(11)
|
|
checked = 0
|
|
for size in range(3, 10):
|
|
for _ in range(400):
|
|
original = [random.choice('abcd') for _ in range(size)]
|
|
if original[0] != original[-1]:
|
|
continue
|
|
checked += 1
|
|
out = sm._unclump_seam(list(original))
|
|
n = len(out)
|
|
before = sum(1 for i in range(n)
|
|
if original[i] == original[(i + 1) % n])
|
|
after = sum(1 for i in range(n) if out[i] == out[(i + 1) % n])
|
|
assert after <= before, (original, out)
|
|
assert sorted(out) == sorted(original), (original, out)
|
|
assert checked > 100, "the generator stopped producing seam cases"
|
|
|
|
def test_a_schedule_too_short_to_repair_is_returned_as_is(self):
|
|
sm = _manager({})
|
|
assert sm._unclump_seam(['a', 'a']) == ['a', 'a']
|
|
assert sm._unclump_seam(['a']) == ['a']
|
|
assert sm._unclump_seam([]) == []
|
|
|
|
def test_a_schedule_with_no_seam_clash_is_untouched(self):
|
|
sm = _manager({})
|
|
plain = ['a', 'b', 'c', 'a', 'd']
|
|
assert sm._unclump_seam(plain) == plain
|
|
|
|
def test_repeats_are_spread_not_clumped(self):
|
|
# The point of Smooth Weighted Round-Robin. Three-in-a-row followed by
|
|
# a long silence would be worse than not boosting at all.
|
|
order = ['weather', 'mlb', 'news', 'clock', 'stocks', 'f1']
|
|
plugins = {p: FakePlugin() for p in order}
|
|
plugins['mlb'] = FakePlugin(live=True)
|
|
sm = _manager(plugins, live_weight=3)
|
|
schedule = sm._apply_priority_weights(order)
|
|
|
|
assert _counts(schedule)['mlb'] == 3
|
|
# Evenly spread over 8 slots means a gap of about 3, never 6.
|
|
assert _max_gap(schedule, 'mlb') <= 4, schedule
|
|
# And never twice running.
|
|
assert not any(a == b == 'mlb' for a, b in zip(schedule, schedule[1:])), schedule
|
|
|
|
def test_a_favorite_outranks_another_live_game(self):
|
|
order = ['weather', 'mlb', 'nhl']
|
|
sm = _manager({'weather': FakePlugin(),
|
|
'mlb': FakePlugin(live=True, declared=5),
|
|
'nhl': FakePlugin(live=True)}, live_weight=2)
|
|
counts = _counts(sm._apply_priority_weights(order))
|
|
assert counts['mlb'] == 5 and counts['nhl'] == 2 and counts['weather'] == 1, counts
|
|
|
|
def test_an_empty_rotation_is_harmless(self):
|
|
assert _manager({})._apply_priority_weights([]) == []
|
|
|
|
|
|
class TestConfigParsing:
|
|
def test_live_games_stay_in_the_ticker_by_default(self):
|
|
cfg = VegasModeConfig.from_config({})
|
|
assert cfg.live_in_ticker is True
|
|
assert cfg.live_weight == 3 and cfg.favorite_live_weight == 5
|
|
|
|
@pytest.mark.parametrize("given,expected", [(0, 1), (-4, 1), (99, 10), (4, 4)])
|
|
def test_weights_are_clamped(self, given, expected):
|
|
cfg = VegasModeConfig.from_config(
|
|
{'display': {'vegas_scroll': {'live_weight': given}}})
|
|
assert cfg.live_weight == expected
|