soulsync/tests/test_youtube_download.py
BoulderBadgeDad 8e071719f9 youtube fulfillment: download worker (pure core)
new core/video/youtube_download.py: fetch a wished youtube video end to end.
plans the organised dest (channel/year/date template), builds yt-dlp opts from
the quality profile (format_selection), runs the download (injectable factory),
then on success marks the video_downloads row completed + archives to history +
removes it from the wishlist; on failure archives failed and KEEPS the wish to
retry. orchestration is pure (yt-dlp run + all db writes injected) + seam-tested;
run_youtube_download binds the real seams for the worker thread.

flows through the SAME video_downloads queue as movies/tv (model B) so the
downloads page + history work for youtube for free.
2026-06-25 19:24:58 -07:00

153 lines
6.9 KiB
Python

"""YouTube download worker — the fulfillment lane for wished YouTube videos. Pure
orchestration (dest planning, yt-dlp opts, completion → archive + unwish, failure →
archive only) tested with the yt-dlp run + all DB writes injected.
"""
from __future__ import annotations
import json
import os
from core.video import youtube_download as ytd
from core.video.youtube_quality import default_profile
# ── organising fields from the queue row ──────────────────────────────────────
def test_fields_prefer_search_ctx_then_fall_back():
dl = {"title": "Some Channel", "year": "2024-01-01", "media_id": "vid1",
"search_ctx": json.dumps({"channel": "Veritasium", "video_title": "Electricity",
"published_at": "2024-03-15"})}
f = ytd.youtube_fields_from_download(dl)
assert f == {"channel": "Veritasium", "title": "Electricity",
"published_at": "2024-03-15", "youtube_id": "vid1"}
def test_fields_fall_back_to_row_when_ctx_absent_or_garbage():
dl = {"title": "Chan", "year": "2024-02-02", "media_id": "v2", "search_ctx": "{bad"}
f = ytd.youtube_fields_from_download(dl)
assert f["channel"] == "Chan" and f["title"] == "Chan"
assert f["published_at"] == "2024-02-02" and f["youtube_id"] == "v2"
# ── destination planning ──────────────────────────────────────────────────────
def test_plan_destination_uses_the_youtube_template():
dl = {"target_dir": "/yt", "media_id": "v1",
"search_ctx": json.dumps({"channel": "Veritasium", "video_title": "How It Works",
"published_at": "2024-03-15"})}
dest = ytd.plan_destination(dl, {}, "mp4")
assert dest["path"] == os.path.join("/yt", "Veritasium", "Season 2024",
"Veritasium - 2024-03-15 - How It Works.mp4")
# ── yt-dlp opts ───────────────────────────────────────────────────────────────
def test_ydl_opts_carry_format_selection_and_fixed_output():
opts = ytd.ydl_download_opts(default_profile(), "/yt/dir", "Chan - 2024-03-15 - Title")
assert opts["format"] == "bv*[height<=1080]+ba/b[height<=1080]/bv*+ba/b"
assert opts["merge_output_format"] == "mp4"
assert opts["paths"] == {"home": "/yt/dir"}
assert opts["outtmpl"] == "Chan - 2024-03-15 - Title.%(ext)s"
assert opts["noplaylist"] is True
# ── download_one with an injected yt-dlp ───────────────────────────────────────
class _FakeYDL:
def __init__(self, opts):
self.opts = opts
_FakeYDL.last = self
def __enter__(self):
return self
def __exit__(self, *a):
return False
def download(self, urls):
self.urls = urls
class _BoomYDL(_FakeYDL):
def download(self, urls):
raise RuntimeError("403 blocked")
def test_download_one_success_returns_built_dest_path():
res = ytd.download_one("vid1", "/yt/Chan/Season 2024", "Chan - 2024-03-15 - T",
default_profile(), "mp4", ydl_factory=_FakeYDL)
assert res["ok"] is True
assert res["dest_path"] == os.path.join("/yt/Chan/Season 2024", "Chan - 2024-03-15 - T.mp4")
assert _FakeYDL.last.urls == ["https://www.youtube.com/watch?v=vid1"]
def test_download_one_failure_is_captured_not_raised():
res = ytd.download_one("vid1", "/yt", "stem", default_profile(), "mp4", ydl_factory=_BoomYDL)
assert res["ok"] is False and "403 blocked" in res["error"]
def test_download_one_no_factory_is_unavailable():
res = ytd.download_one("vid1", "/yt", "stem", default_profile(), "mp4", ydl_factory=None)
# yt_dlp may or may not be importable in the test env; either way no real run happens
if res["ok"] is False:
assert res["error"]
# ── the orchestration: completion vs failure ──────────────────────────────────
def _recorder():
calls = {"rows": [], "archive": [], "unwish": []}
def update_row(dl_id, **kw):
calls["rows"].append((dl_id, kw))
def archive(row, upd):
calls["archive"].append(upd)
def clear_wishlist(vid):
calls["unwish"].append(vid)
return calls, update_row, archive, clear_wishlist
def _dl():
return {"id": 7, "media_id": "vid1", "target_dir": "/yt", "title": "Chan", "year": "2024-03-15",
"search_ctx": json.dumps({"channel": "Chan", "video_title": "T", "published_at": "2024-03-15"})}
def test_process_completion_archives_and_unwishes():
calls, update_row, archive, clear = _recorder()
res = ytd.process_youtube_download(
_dl(), profile=default_profile(), settings={},
download=lambda *a, **k: {"ok": True, "dest_path": "/yt/Chan/Season 2024/Chan - 2024-03-15 - T.mp4"},
update_row=update_row, archive=archive, clear_wishlist=clear, now=lambda: "2026-06-25T00:00:00+00:00")
assert res["status"] == "completed"
# row marked completed, history snapshot 'completed', and the video unwished
statuses = [kw.get("status") for _, kw in calls["rows"]]
assert "downloading" in statuses and statuses[-1] == "completed"
assert calls["archive"][-1]["status"] == "completed"
assert calls["unwish"] == ["vid1"]
def test_process_failure_archives_but_keeps_the_wish():
calls, update_row, archive, clear = _recorder()
res = ytd.process_youtube_download(
_dl(), profile=default_profile(), settings={},
download=lambda *a, **k: {"ok": False, "error": "yt-dlp said no"},
update_row=update_row, archive=archive, clear_wishlist=clear, now=lambda: "t")
assert res["status"] == "failed" and "yt-dlp said no" in res["error"]
assert calls["rows"][-1][1]["status"] == "failed"
assert calls["archive"][-1]["status"] == "failed"
assert calls["unwish"] == [] # wish kept so it can retry later
def test_process_passes_the_organised_dir_to_the_downloader():
seen = {}
def fake_download(video_id, dest_dir, stem, profile, container, **kw):
seen.update(video_id=video_id, dest_dir=dest_dir, stem=stem, container=container)
return {"ok": True, "dest_path": "/x"}
calls, update_row, archive, clear = _recorder()
ytd.process_youtube_download(_dl(), profile=default_profile(), settings={},
download=fake_download, update_row=update_row,
archive=archive, clear_wishlist=clear, now=lambda: "t")
assert seen["video_id"] == "vid1"
assert seen["dest_dir"] == os.path.join("/yt", "Chan", "Season 2024")
assert seen["stem"] == "Chan - 2024-03-15 - T" and seen["container"] == "mp4"