From 1e3b6323d7faf38ac0b2b842b43b805d32c55d5c Mon Sep 17 00:00:00 2001 From: jbannon Date: Sun, 7 Aug 2022 21:36:48 +0000 Subject: [PATCH] test dl args --- src/ytdl_sub/cli/main.py | 5 ++-- tests/conftest.py | 37 ++++++++++++++++++++++++-- tests/e2e/conftest.py | 22 +++++++++++++-- tests/e2e/youtube/test_video.py | 47 ++++++++++++++++++++++----------- 4 files changed, 90 insertions(+), 21 deletions(-) diff --git a/src/ytdl_sub/cli/main.py b/src/ytdl_sub/cli/main.py index 9734b966..bcd8fb54 100644 --- a/src/ytdl_sub/cli/main.py +++ b/src/ytdl_sub/cli/main.py @@ -89,14 +89,14 @@ def _download_subscription_from_cli( return subscription, subscription.download(dry_run=args.dry_run) -def main(): +def main() -> List[Tuple[Subscription, FileHandlerTransactionLog]]: """ Entrypoint for ytdl-sub, without the error handling """ # If no args are provided, print help and exit if len(sys.argv) < 2: parser.print_help() - return + return [] args, extra_args = parser.parse_known_args() @@ -123,3 +123,4 @@ def main(): # Ran successfully, so we can delete the debug file Logger.cleanup(delete_debug_file=True) + return transaction_logs diff --git a/tests/conftest.py b/tests/conftest.py index 122419e1..fd7e8944 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,7 +1,8 @@ import contextlib import logging -from typing import Callable -from unittest.mock import MagicMock +from typing import Any +from typing import Dict +from typing import List from unittest.mock import patch from ytdl_sub.utils.logger import Logger @@ -26,3 +27,35 @@ def assert_debug_log(logger: logging.Logger, expected_message: str): return assert False, f"{expected_message} was not found in a logger.debug call" + + +def preset_dict_to_dl_args(preset_dict: Dict) -> str: + """ + Parameters + ---------- + preset_dict + Preset dict to convert + + Returns + ------- + Preset dict converted to CLI parameters + """ + + def _recursive_preset_args(cli_key: str, current_value: Dict | Any) -> List[str]: + if isinstance(current_value, dict): + preset_args: List[str] = [] + for v_key, v_value in current_value.items(): + preset_args.extend( + _recursive_preset_args( + cli_key=f"{cli_key}.{v_key}" if cli_key else v_key, current_value=v_value + ) + ) + return preset_args + elif isinstance(current_value, list): + return [ + f"--{cli_key}[{idx + 1}] {current_value[idx]}" for idx in range(len(current_value)) + ] + else: + return [f"--{cli_key} {current_value}"] + + return " ".join(_recursive_preset_args(cli_key="", current_value=preset_dict)) diff --git a/tests/e2e/conftest.py b/tests/e2e/conftest.py index 29842c40..3b988eba 100644 --- a/tests/e2e/conftest.py +++ b/tests/e2e/conftest.py @@ -1,8 +1,15 @@ +import sys import tempfile +from typing import List +from typing import Tuple +from unittest.mock import patch import pytest +from ytdl_sub.cli.main import main from ytdl_sub.config.config_file import ConfigFile +from ytdl_sub.subscriptions.subscription import Subscription +from ytdl_sub.utils.file_handler import FileHandlerTransactionLog @pytest.fixture() @@ -12,8 +19,13 @@ def output_directory(): @pytest.fixture() -def music_video_config(): - return ConfigFile.from_file_path(config_path="examples/kodi_music_videos_config.yaml") +def music_video_config_path(): + return "examples/kodi_music_videos_config.yaml" + + +@pytest.fixture() +def music_video_config(music_video_config_path): + return ConfigFile.from_file_path(config_path=music_video_config_path) @pytest.fixture() @@ -41,3 +53,9 @@ def timestamps_file_path(): tmp.writelines(timestamps) tmp.seek(0) yield tmp.name + + +def mock_run_from_cli(args: str) -> List[Tuple[Subscription, FileHandlerTransactionLog]]: + args_list = ["ytdl-sub"] + args.split() + with patch.object(sys, "argv", args_list): + return main() diff --git a/tests/e2e/youtube/test_video.py b/tests/e2e/youtube/test_video.py index f35bfba1..a569827d 100644 --- a/tests/e2e/youtube/test_video.py +++ b/tests/e2e/youtube/test_video.py @@ -1,6 +1,8 @@ from pathlib import Path import pytest +from conftest import preset_dict_to_dl_args +from e2e.conftest import mock_run_from_cli from e2e.expected_download import ExpectedDownloadFile from e2e.expected_download import ExpectedDownloads from e2e.expected_transaction_log import assert_transaction_log_matches @@ -8,21 +10,6 @@ from e2e.expected_transaction_log import assert_transaction_log_matches from ytdl_sub.subscriptions.subscription import Subscription -@pytest.fixture -def playlist_preset_dict(output_directory): - return { - "preset": "yt_music_video_playlist", - "youtube": {"playlist_url": "https://youtube.com/playlist?list=PL5BC0FC26BECA5A35"}, - # override the output directory with our fixture-generated dir - "output_options": {"output_directory": output_directory}, - # download the worst format so it is fast - "ytdl_options": { - "format": "worst[ext=mp4]", - }, - "overrides": {"artist": "JMC"}, - } - - @pytest.fixture def single_video_preset_dict(output_directory): return { @@ -38,6 +25,11 @@ def single_video_preset_dict(output_directory): } +@pytest.fixture +def single_video_preset_dict_dl_args(single_video_preset_dict): + return preset_dict_to_dl_args(single_video_preset_dict) + + @pytest.fixture def expected_single_video_download(): # turn off black formatter here for readability @@ -91,6 +83,31 @@ class TestYoutubeVideo: if not dry_run: expected_single_video_download.assert_files_exist(relative_directory=output_directory) + @pytest.mark.parametrize("dry_run", [True, False]) + def test_single_video_download_from_cli_dl( + self, + music_video_config_path, + single_video_preset_dict_dl_args, + expected_single_video_download, + output_directory, + dry_run, + ): + args = "--dry-run " if dry_run else "" + args += f"--config {music_video_config_path} " + args += f"dl {single_video_preset_dict_dl_args}" + subscription_transaction_log = mock_run_from_cli(args=args) + + assert len(subscription_transaction_log) == 1 + transaction_log = subscription_transaction_log[0][1] + + assert_transaction_log_matches( + output_directory=output_directory, + transaction_log=transaction_log, + transaction_log_summary_file_name="youtube/test_video.txt", + ) + if not dry_run: + expected_single_video_download.assert_files_exist(relative_directory=output_directory) + @pytest.mark.parametrize("dry_run", [True, False]) def test_single_video_with_timestamp_chapters_download( self,