309f259464
With the recent push to 'beautify subscriptions' (see https://github.com/jmbannon/ytdl-sub/releases/tag/2023.10.02), we need the ability to change subscription names from their legacy form: ``` rick_a: preset: - "tv_show" overrides: tv_show_name: "Rick A" url: "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw" ``` into: ``` tv_show: "Rick A": "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw" ``` This however has implications from ytdl-sub's legacy download archive naming. By default, we write archives to `.ytdl-sub-{subscription_name}-download-archive.json`. If we change the subscription name, the archive will not be found, causing a complete redownload. This new feature gives us the ability to migrate download archives to a new naming schema. # Migrating to Beautified Subscriptions ## Step 0 BACK UP ALL CONFIG + SUBSCRIPTION FILES!!!!! If something goes wrong, restore your backup and try again and/or ask for help. ## Step 1 Since we know we'll be changing our `subscripion_name` to the value of `tv_show_name`, we can use that in our newly migrated download archive name by setting this within the `tv_show` preset (or whatever your 'base' preset is). ``` presets: tv_show: output_options: migrated_download_archive_name: ".{tv_show_name_sanitized}-download-archive.json" ``` ## Step 2 Perform a download as usual, via `ytdl-sub sub ...`. This will load the old archive, and save it into the new archive. You should see `MIGRATION DETECTED` within the logs. Ensure it completes successfully. Perform another download invocation and ensure you see the `MIGRATION SUCCESSFUL` within the logs. ## Step 3 Now we can set: ``` presets: tv_show: output_options: # rename migrated_download_archive_name to just download_archive_name download_archive_name: ".{tv_show_name_sanitized}-download-archive.json" overrides: tv_show_name: "{subscription_name}" url: "{subscription_value}" ``` Our download archives now default to our new format, and we set `tv_show_name` + `url` to use subscription values by default. ## Step 4 We can now beautify our subscription.yaml file to: ``` tv_show: "Rick A": "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw" ```
59 lines
2.3 KiB
Python
59 lines
2.3 KiB
Python
import os
|
|
from pathlib import Path
|
|
from typing import List
|
|
|
|
from resources import REGENERATE_FIXTURES
|
|
from resources import RESOURCE_PATH
|
|
|
|
from ytdl_sub.utils.file_handler import FileHandlerTransactionLog
|
|
|
|
_TRANSACTION_LOG_SUMMARY_PATH = RESOURCE_PATH / "transaction_log_summaries"
|
|
|
|
|
|
def assert_transaction_log_matches(
|
|
output_directory: Path,
|
|
transaction_log: FileHandlerTransactionLog,
|
|
transaction_log_summary_file_name: str,
|
|
):
|
|
"""
|
|
Parameters
|
|
----------
|
|
output_directory
|
|
Output directory the files are saved to
|
|
transaction_log
|
|
Transaction log to check
|
|
transaction_log_summary_file_name
|
|
Name if the transaction log summary to compare.
|
|
Lives in tests/e2e/resources/transaction_log_summaries
|
|
"""
|
|
transaction_log_path = _TRANSACTION_LOG_SUMMARY_PATH / transaction_log_summary_file_name
|
|
summary = transaction_log.to_output_message(output_directory=output_directory)
|
|
|
|
# USE WITH CAUTION - MANUALLY INSPECT CHANGED FILES TO ENSURE THEY LOOK GOOD!
|
|
# Updates the file with the input transaction log. Should only be used to update
|
|
# tests after an expected change is made.
|
|
if REGENERATE_FIXTURES:
|
|
os.makedirs(os.path.dirname(transaction_log_path), exist_ok=True)
|
|
with open(transaction_log_path, "w", encoding="utf-8") as summary_file:
|
|
summary_file.write(
|
|
transaction_log.to_output_message(output_directory="{output_directory}")
|
|
)
|
|
|
|
# Read the expected summary file
|
|
with open(transaction_log_path, "r", encoding="utf-8") as summary_file:
|
|
expected_summary = summary_file.read().format(
|
|
output_directory=FileHandlerTransactionLog.format_path_str(output_directory)
|
|
)
|
|
|
|
# Split, ensure there are the same number of new lines
|
|
summary_lines: List[str] = summary.split("\n")
|
|
expected_summary_lines: List[str] = expected_summary.split("\n")
|
|
assert len(summary_lines) == len(
|
|
expected_summary_lines
|
|
), f"Summary number of lines differ: {len(summary_lines) != len(expected_summary_lines)}"
|
|
|
|
# Ensure each line equals
|
|
for idx in range(len(summary_lines)):
|
|
line = summary_lines[idx]
|
|
expected_line = expected_summary_lines[idx]
|
|
assert line == expected_line, f"Summary line {idx} differs: '{line}' != '{expected_line}'"
|