ytdl-sub/tests/unit
Jesse Bannon 309f259464
[FEATURE] Ability to migrate download archive files (#751)
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"
```
2023-10-03 16:08:14 -07:00
..
cli [FEATURE][EXPERIMENTAL] --update-with-info-json (#557) 2023-03-21 08:05:08 -07:00
config [FEATURE] Subscription nesting (#747) 2023-10-02 16:07:48 -07:00
entries [FEATURE] release_date source variables (#638) 2023-06-24 23:01:18 -07:00
main [BACKEND] More explicit error message for PermissionError (#736) 2023-09-21 23:06:57 -07:00
plugins [FEATURE] Regex capture and filtering on source variables plugin (#100) 2022-07-16 23:39:46 -07:00
prebuilt_presets [FEATURE] Ability to migrate download archive files (#751) 2023-10-03 16:08:14 -07:00
utils [BACKEND] Include yaml exception in error (#678) 2023-07-29 23:05:34 -07:00
validators [FEATURE] Configurable file_name_max_bytes (#562) 2023-03-25 20:17:38 -07:00
__init__.py entry 100% test coverage 2022-03-30 16:48:04 +00:00