soulsync/tests/downloads/test_qobuz_pinning.py
Broque Thomas c4c922c40f Surface engine-not-wired errors + exclude soulseek from monitor aggregation
Two findings from JohnBaumb on the engine refactor.

(1) Every download client returned None when self._engine was None,
just logging an error. The orchestrator's download_with_fallback
treated None as "source declined", so the user got no feedback —
download silently disappeared. Now each client raises a RuntimeError
on the engine-not-wired path. download_with_fallback already catches
plugin exceptions, logs a warning, and tries the next source — so
the visible behavior is "real error in logs + fallback to next
source" instead of "silent drop". Six clients touched (deezer, hifi,
qobuz, soundcloud, tidal, youtube). Pinning tests updated to expect
raise.

(2) Monitor's engine.get_all_downloads() walked every plugin
including soulseek, but the same monitor loop already pulled slskd
transfers via the transfers/downloads endpoint a few lines earlier —
soulseek's records were being fetched twice per tick. Same issue in
web_server.py's get_cached_transfer_data path. Added an exclude
parameter to engine.get_all_downloads(); both call sites now pass
('soulseek',). New test pins the exclude semantic.

Also fixed a stray 8-space over-indent on the for-loop body in
get_cached_transfer_data (cosmetic, JohnBaumb flagged the same
pattern in monitor.py earlier).
2026-05-05 12:20:51 -07:00

121 lines
4.1 KiB
Python

"""Phase A pinning tests for QobuzClient — UPDATED for Phase C4.
Post-C4 the client uses engine.worker for thread + state management.
"""
from __future__ import annotations
import asyncio
import threading
from pathlib import Path
from unittest.mock import patch
import pytest
from core.download_engine import DownloadEngine
from core.qobuz_client import QobuzClient
def _run_async(coro):
loop = asyncio.new_event_loop()
try:
return loop.run_until_complete(coro)
finally:
loop.close()
@pytest.fixture
def qobuz_client_with_engine():
client = QobuzClient.__new__(QobuzClient)
client.download_path = Path('./test_qobuz_downloads')
client.shutdown_check = None
client._engine = None
engine = DownloadEngine()
client.set_engine(engine)
return client, engine
def test_download_returns_none_for_invalid_filename_format(qobuz_client_with_engine):
client, _ = qobuz_client_with_engine
result = _run_async(client.download('qobuz', 'no-separator', 0))
assert result is None
def test_download_returns_none_for_non_integer_track_id(qobuz_client_with_engine):
client, _ = qobuz_client_with_engine
result = _run_async(client.download('qobuz', 'not-int||title', 0))
assert result is None
def test_download_raises_when_engine_not_wired():
"""Defensive: client without engine reference must raise so the
orchestrator's download_with_fallback surfaces the error and
moves on to the next source. Returning None silently would drop
the download with no user feedback (per JohnBaumb)."""
import pytest
client = QobuzClient.__new__(QobuzClient)
client._engine = None
with pytest.raises(RuntimeError, match="engine reference"):
_run_async(client.download('qobuz', 'v||t', 0))
def test_download_returns_uuid_for_valid_filename(qobuz_client_with_engine):
client, _ = qobuz_client_with_engine
with patch.object(client, '_download_sync', return_value='/tmp/x.flac'):
result = _run_async(client.download('qobuz', '12345||Some Song', 0))
assert result is not None
assert len(result) == 36
def test_download_populates_engine_record_with_initial_state(qobuz_client_with_engine):
client, engine = qobuz_client_with_engine
started = threading.Event()
release = threading.Event()
def slow_impl(*args, **kwargs):
started.set()
release.wait(timeout=1.0)
return '/tmp/done.flac'
with patch.object(client, '_download_sync', side_effect=slow_impl):
download_id = _run_async(client.download('qobuz', '999||My Qobuz Song', 0))
started.wait(timeout=1.0)
record = engine.get_record('qobuz', download_id)
assert record is not None
assert record['filename'] == '999||My Qobuz Song'
assert record['username'] == 'qobuz'
assert record['track_id'] == 999
assert record['display_name'] == 'My Qobuz Song'
release.set()
def test_get_all_downloads_reads_engine_records(qobuz_client_with_engine):
client, engine = qobuz_client_with_engine
engine.add_record('qobuz', 'dl-1', {
'id': 'dl-1', 'filename': '111||A', 'username': 'qobuz',
'state': 'InProgress, Downloading', 'progress': 50.0,
})
result = _run_async(client.get_all_downloads())
assert len(result) == 1
assert result[0].id == 'dl-1'
def test_cancel_download_marks_cancelled(qobuz_client_with_engine):
client, engine = qobuz_client_with_engine
engine.add_record('qobuz', 'dl-1', {'id': 'dl-1', 'state': 'InProgress, Downloading'})
ok = _run_async(client.cancel_download('dl-1', None, remove=False))
assert ok is True
assert engine.get_record('qobuz', 'dl-1')['state'] == 'Cancelled'
def test_clear_all_completed_drops_only_terminal_records(qobuz_client_with_engine):
client, engine = qobuz_client_with_engine
engine.add_record('qobuz', 'done', {'id': 'done', 'state': 'Completed, Succeeded'})
engine.add_record('qobuz', 'live', {'id': 'live', 'state': 'InProgress, Downloading'})
_run_async(client.clear_all_completed_downloads())
assert engine.get_record('qobuz', 'done') is None
assert engine.get_record('qobuz', 'live') is not None