ytdl-sub/tests/unit/plugins/test_ytdl_options.py
Jesse Bannon 57fd6901e4
[DEV] Linter: Use ruff over black and isort (#1445)
Will eventually replace pylint with ruff
2026-03-09 11:39:01 -07:00

109 lines
3.5 KiB
Python

import re
from typing import Any, Dict
import pytest
import yt_dlp
from conftest import assert_logs
from ytdl_sub.config.config_file import ConfigFile
from ytdl_sub.downloaders.ytdlp import YTDLP
from ytdl_sub.subscriptions.subscription import Subscription
from ytdl_sub.utils.exceptions import ValidationException
from ytdl_sub.utils.ffmpeg import FFMPEG
from ytdl_sub.utils.file_path import FilePathTruncater
@pytest.fixture
def preset_dict(output_directory) -> Dict[str, Any]:
return {
"download": "https://your.name.here",
"output_options": {"output_directory": output_directory, "file_name": "will_error.mp4"},
}
class TestYtdlOptions:
def test_ytdl_options_are_strings(
self,
default_config: ConfigFile,
preset_dict: Dict[str, Any],
working_directory,
):
expected_ytdl_options = {
"ignoreerrors": True,
"outtmpl": FilePathTruncater.to_native_filepath(
f"{working_directory}/test_ytdl_options/%(id)S.%(ext)s"
),
"writethumbnail": False,
"ffmpeg_location": FFMPEG.ffmpeg_path(),
"match_filter": yt_dlp.utils.match_filter_func(
["!is_live & !is_upcoming & !post_live"], []
),
"skip_download": True,
"writeinfojson": True,
"extract_flat": "discard",
}
with (
assert_logs(
logger=YTDLP.logger,
expected_message=f"ytdl_options: {str(expected_ytdl_options)}",
log_level="debug",
expected_occurrences=1,
),
):
_ = Subscription.from_dict(
config=default_config,
preset_name="test_ytdl_options",
preset_dict=preset_dict,
).download(dry_run=True)
def test_cookiefile_does_not_exist(
self,
default_config: ConfigFile,
preset_dict: Dict[str, Any],
):
preset_dict["ytdl_options"] = {
"cookiefile": "/path/to/nowhere",
}
error_msg = "Specified cookiefile /path/to/nowhere but it does not exist as a file."
with pytest.raises(ValidationException, match=re.escape(error_msg)):
Subscription.from_dict(
config=default_config,
preset_name="test_ytdl_options",
preset_dict=preset_dict,
).download(dry_run=False)
def test_ytdl_option_types_preserved(
self,
default_config: ConfigFile,
output_directory: str,
):
preset_dict = {
"download": "https://your.name.here",
"output_options": {"output_directory": output_directory, "file_name": "will_error.mp4"},
"ytdl_options": {
"break_on_existing": True,
"js_runtimes": {"deno": {"path": "/usr/local/bin/{dnope}"}},
"string_path": "verify overrides: {test_string}",
"list_test": ["hmmm"],
},
"overrides": {"test_string": "hi", "dnope": "deno"},
}
sub = Subscription.from_dict(
config=default_config,
preset_name="test_ytdl_options",
preset_dict=preset_dict,
)
out = sub.ytdl_options.to_native_dict(sub.overrides)
expected = {
"break_on_existing": True,
"js_runtimes": {"deno": {"path": "/usr/local/bin/deno"}},
"string_path": "verify overrides: hi",
"list_test": ["hmmm"],
}
assert out == expected