metube/app/tests/test_config.py

"""Tests for ``Config`` (env parsing, yt-dlp options, frontend_safe)."""

from __future__ import annotations

import json
import os
import tempfile
import unittest
from unittest.mock import patch

from main import Config


def _base_env(**overrides: str) -> dict[str, str]:
    env = {k: str(v) for k, v in Config._DEFAULTS.items()}
    env.update(overrides)
    return env


class ConfigTests(unittest.TestCase):
    def test_url_prefix_gets_trailing_slash(self):
        with patch.dict(os.environ, _base_env(URL_PREFIX="foo"), clear=False):
            c = Config()
        self.assertEqual(c.URL_PREFIX, "foo/")

    def test_public_host_url_gets_trailing_slash(self):
        with patch.dict(
            os.environ,
            _base_env(PUBLIC_HOST_URL="https://ytdl.example.com"),
            clear=False,
        ):
            c = Config()
        self.assertEqual(c.PUBLIC_HOST_URL, "https://ytdl.example.com/")

    def test_public_host_audio_url_gets_trailing_slash(self):
        with patch.dict(
            os.environ,
            _base_env(PUBLIC_HOST_AUDIO_URL="https://audio.example.com"),
            clear=False,
        ):
            c = Config()
        self.assertEqual(c.PUBLIC_HOST_AUDIO_URL, "https://audio.example.com/")

    def test_public_host_url_empty_stays_empty(self):
        with patch.dict(
            os.environ,
            _base_env(PUBLIC_HOST_URL="", PUBLIC_HOST_AUDIO_URL=""),
            clear=False,
        ):
            c = Config()
        self.assertEqual(c.PUBLIC_HOST_URL, "")
        self.assertEqual(c.PUBLIC_HOST_AUDIO_URL, "")

    def test_blank_audio_host_inherits_public_host_url(self):
        # Regression: a blank PUBLIC_HOST_AUDIO_URL must inherit PUBLIC_HOST_URL, not stay root-relative.
        with patch.dict(
            os.environ,
            _base_env(PUBLIC_HOST_URL="download/", PUBLIC_HOST_AUDIO_URL=""),
            clear=False,
        ):
            c = Config()
        self.assertEqual(c.PUBLIC_HOST_URL, "download/")
        self.assertEqual(c.PUBLIC_HOST_AUDIO_URL, "download/")

    def test_blank_audio_host_audio_link_is_not_root_relative(self):
        # Repro of the reported bug. buildDownloadLink uses configuration[PUBLIC_HOST_AUDIO_URL]
        # as the base for audio, so a blank value made the link "song.mp3" (root-relative, 404)
        # while video kept working off PUBLIC_HOST_URL. The base must be prefixed instead.
        with patch.dict(
            os.environ,
            _base_env(PUBLIC_HOST_URL="download/", PUBLIC_HOST_AUDIO_URL=""),
            clear=False,
        ):
            c = Config()
        audio_link = c.PUBLIC_HOST_AUDIO_URL + "song.mp3"
        video_link = c.PUBLIC_HOST_URL + "video.mp4"
        self.assertEqual(video_link, "download/video.mp4")
        self.assertNotEqual(audio_link, "song.mp3")
        self.assertEqual(audio_link, "download/song.mp3")

    def test_unset_audio_host_keeps_default_route(self):
        # Truly unset (not blank) keeps the 'audio_download/' default route.
        env = _base_env()
        env.pop("PUBLIC_HOST_AUDIO_URL", None)
        env.pop("PUBLIC_HOST_URL", None)
        with patch.dict(os.environ, env, clear=True):
            c = Config()
        self.assertEqual(c.PUBLIC_HOST_URL, "download/")
        self.assertEqual(c.PUBLIC_HOST_AUDIO_URL, "audio_download/")

    def test_public_host_url_already_slashed_unchanged(self):
        with patch.dict(
            os.environ,
            _base_env(
                PUBLIC_HOST_URL="https://ytdl.example.com/",
                PUBLIC_HOST_AUDIO_URL="https://audio.example.com/",
            ),
            clear=False,
        ):
            c = Config()
        self.assertEqual(c.PUBLIC_HOST_URL, "https://ytdl.example.com/")
        self.assertEqual(c.PUBLIC_HOST_AUDIO_URL, "https://audio.example.com/")

    def test_ytdl_options_json_loaded(self):
        opts = {"quiet": True, "no_warnings": True}
        with patch.dict(
            os.environ,
            _base_env(YTDL_OPTIONS=json.dumps(opts)),
            clear=False,
        ):
            c = Config()
        self.assertEqual(c.YTDL_OPTIONS["quiet"], True)

    def test_ytdl_option_presets_json_loaded(self):
        presets = {"Audio extras": {"embed_thumbnail": True}}
        with patch.dict(
            os.environ,
            _base_env(YTDL_OPTIONS_PRESETS=json.dumps(presets)),
            clear=False,
        ):
            c = Config()
        self.assertEqual(c.YTDL_OPTIONS_PRESETS["Audio extras"]["embed_thumbnail"], True)

    def test_invalid_ytdl_options_exits(self):
        with patch.dict(os.environ, _base_env(YTDL_OPTIONS="not-json"), clear=False):
            with self.assertRaises(SystemExit):
                Config()

    def test_invalid_boolean_env_exits(self):
        with patch.dict(os.environ, _base_env(CUSTOM_DIRS="maybe"), clear=False):
            with self.assertRaises(SystemExit):
                Config()

    def test_frontend_safe_excludes_secrets(self):
        with patch.dict(os.environ, _base_env(), clear=False):
            c = Config()
        safe = c.frontend_safe()
        self.assertNotIn("YTDL_OPTIONS", safe)
        self.assertNotIn("HOST", safe)
        self.assertEqual(safe["ALLOW_YTDL_OPTIONS_OVERRIDES"], False)

    def test_allow_ytdl_options_overrides_boolean_loaded(self):
        with patch.dict(os.environ, _base_env(ALLOW_YTDL_OPTIONS_OVERRIDES="true"), clear=False):
            c = Config()
        self.assertTrue(c.ALLOW_YTDL_OPTIONS_OVERRIDES)

    def test_ytdl_nightly_update_time_empty_default(self):
        with patch.dict(os.environ, _base_env(YTDL_NIGHTLY_UPDATE_TIME=""), clear=False):
            c = Config()
        self.assertEqual(c.YTDL_NIGHTLY_UPDATE_TIME, "")

    def test_ytdl_nightly_update_time_valid(self):
        with patch.dict(os.environ, _base_env(YTDL_NIGHTLY_UPDATE_TIME="04:00"), clear=False):
            c = Config()
        self.assertEqual(c.YTDL_NIGHTLY_UPDATE_TIME, "04:00")

    def test_ytdl_nightly_update_time_invalid_exits(self):
        for bad in ("25:00", "4am", "12:60"):
            with patch.dict(os.environ, _base_env(YTDL_NIGHTLY_UPDATE_TIME=bad), clear=False):
                with self.assertRaises(SystemExit):
                    Config()

    def test_runtime_override_roundtrip(self):
        with patch.dict(os.environ, _base_env(), clear=False):
            c = Config()
            c.set_runtime_override("cookiefile", "/tmp/c.txt")
            self.assertEqual(c.YTDL_OPTIONS.get("cookiefile"), "/tmp/c.txt")
            c.remove_runtime_override("cookiefile")
            self.assertIsNone(c.YTDL_OPTIONS.get("cookiefile"))

    def test_ytdl_options_file_merges(self):
        with tempfile.NamedTemporaryFile("w", suffix=".json", delete=False) as f:
            json.dump({"extractor_args": {"youtube": {"player_client": ["web"]}}}, f)
            path = f.name
        try:
            with patch.dict(
                os.environ,
                _base_env(YTDL_OPTIONS="{}", YTDL_OPTIONS_FILE=path),
                clear=False,
            ):
                c = Config()
            self.assertIn("extractor_args", c.YTDL_OPTIONS)
        finally:
            os.unlink(path)

    def test_ytdl_option_presets_file_merges(self):
        with tempfile.NamedTemporaryFile("w", suffix=".json", delete=False) as f:
            json.dump({"With subtitles": {"writesubtitles": True}}, f)
            path = f.name
        try:
            with patch.dict(
                os.environ,
                _base_env(YTDL_OPTIONS_PRESETS="{}", YTDL_OPTIONS_PRESETS_FILE=path),
                clear=False,
            ):
                c = Config()
            self.assertIn("With subtitles", c.YTDL_OPTIONS_PRESETS)
        finally:
            os.unlink(path)


if __name__ == "__main__":
    unittest.main()