fergalmoran/picard
1
0
Fork 0
mirror of https://github.com/fergalmoran/picard.git synced 2025-12-29 04:37:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
466fc59d0f60f5c43c0381514238a96097c49d89
picard/test/test_config_upgrade.py
Philipp Wolfer 03449e01d3 PICARD-2630: Fix potential crash on config upgrade
2023-04-18 10:43:10 +02:00

367 lines
16 KiB
Python
Raw Blame History

# -*- coding: utf-8 -*-
#
# Picard, the next-generation MusicBrainz tagger
#
# Copyright (C) 2019-2021 Laurent Monin
# Copyright (C) 2019-2023 Philipp Wolfer
# Copyright (C) 2021 Bob Swift
# Copyright (C) 2021 Gabriel Ferreira
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
from PyQt5.QtCore import QByteArray
from test.test_config import TestPicardConfigCommon
from picard.config import (
BoolOption,
IntOption,
ListOption,
Option,
TextOption,
)
import picard.config_upgrade
from picard.config_upgrade import (
OLD_DEFAULT_FILE_NAMING_FORMAT_v1_3,
OLD_DEFAULT_FILE_NAMING_FORMAT_v2_1,
upgrade_to_v1_0_0_final_0,
upgrade_to_v1_3_0_dev_1,
upgrade_to_v1_3_0_dev_2,
upgrade_to_v1_3_0_dev_3,
upgrade_to_v1_3_0_dev_4,
upgrade_to_v1_4_0_dev_2,
upgrade_to_v1_4_0_dev_3,
upgrade_to_v1_4_0_dev_4,
upgrade_to_v1_4_0_dev_6,
upgrade_to_v1_4_0_dev_7,
upgrade_to_v2_0_0_dev_3,
upgrade_to_v2_1_0_dev_1,
upgrade_to_v2_2_0_dev_3,
upgrade_to_v2_2_0_dev_4,
upgrade_to_v2_4_0_beta_3,
upgrade_to_v2_5_0_dev_1,
upgrade_to_v2_5_0_dev_2,
upgrade_to_v2_6_0_beta_2,
upgrade_to_v2_6_0_beta_3,
upgrade_to_v2_6_0_dev_1,
upgrade_to_v2_8_0_dev_2,
)
from picard.const import (
DEFAULT_FILE_NAMING_FORMAT,
DEFAULT_SCRIPT_NAME,
)
from picard.util import unique_numbered_title
class TestPicardConfigUpgrades(TestPicardConfigCommon):
def test_upgrade_to_v1_0_0_final_0_A(self):
TextOption('setting', 'file_naming_format', '')
self.config.setting['va_file_naming_format'] = 'abc'
self.config.setting['use_va_format'] = True
self.assertIn('va_file_naming_format', self.config.setting)
self.assertIn('use_va_format', self.config.setting)
upgrade_to_v1_0_0_final_0(self.config, interactive=False, merge=True)
self.assertNotIn('va_file_naming_format', self.config.setting)
self.assertNotIn('use_va_format', self.config.setting)
self.assertIn('file_naming_format', self.config.setting)
def test_upgrade_to_v1_0_0_final_0_B(self):
TextOption('setting', 'file_naming_format', '')
self.config.setting['va_file_naming_format'] = 'abc'
self.config.setting['use_va_format'] = ""
self.assertIn('va_file_naming_format', self.config.setting)
self.assertIn('use_va_format', self.config.setting)
upgrade_to_v1_0_0_final_0(self.config, interactive=False, merge=False)
self.assertNotIn('va_file_naming_format', self.config.setting)
self.assertNotIn('use_va_format', self.config.setting)
self.assertNotIn('file_naming_format', self.config.setting)
def test_upgrade_to_v1_3_0_dev_1(self):
BoolOption('setting', 'windows_compatibility', False)
self.config.setting['windows_compatible_filenames'] = True
upgrade_to_v1_3_0_dev_1(self.config)
self.assertNotIn('windows_compatible_filenames', self.config.setting)
self.assertTrue(self.config.setting['windows_compatibility'])
def test_upgrade_to_v1_3_0_dev_2(self):
TextOption('setting', 'preserved_tags', '')
self.config.setting['preserved_tags'] = "a b c "
upgrade_to_v1_3_0_dev_2(self.config)
self.assertEqual("a,b,c", self.config.setting['preserved_tags'])
def test_upgrade_to_v1_3_0_dev_2_skip_list(self):
ListOption('setting', 'preserved_tags', [])
self.config.setting['preserved_tags'] = ['foo']
upgrade_to_v1_3_0_dev_2(self.config)
self.assertEqual(['foo'], self.config.setting['preserved_tags'])
def test_upgrade_to_v1_3_0_dev_3(self):
ListOption("setting", "preferred_release_countries", [])
ListOption("setting", "preferred_release_formats", [])
ListOption("setting", "enabled_plugins", [])
ListOption("setting", "caa_image_types", [])
ListOption("setting", "metadata_box_sizes", [])
self.config.setting['preferred_release_countries'] = "a b c"
self.config.setting['preferred_release_formats'] = "a b c"
self.config.setting['enabled_plugins'] = 'a b c'
self.config.setting['caa_image_types'] = 'a b c'
self.config.setting['metadata_box_sizes'] = 'a b c'
upgrade_to_v1_3_0_dev_3(self.config)
self.assertEqual(["a", "b", "c"], self.config.setting['preferred_release_countries'])
self.assertEqual(["a", "b", "c"], self.config.setting['preferred_release_formats'])
self.assertEqual(["a", "b", "c"], self.config.setting['enabled_plugins'])
self.assertEqual(["a", "b", "c"], self.config.setting['caa_image_types'])
self.assertEqual(["a", "b", "c"], self.config.setting['metadata_box_sizes'])
def test_upgrade_to_v1_3_0_dev_4(self):
ListOption("setting", "release_type_scores", [])
self.config.setting['release_type_scores'] = "a 0.1 b 0.2 c 1"
upgrade_to_v1_3_0_dev_4(self.config)
self.assertEqual([('a', 0.1), ('b', 0.2), ('c', 1.0)], self.config.setting['release_type_scores'])
def test_upgrade_to_v1_4_0_dev_2(self):
self.config.setting['username'] = 'abc'
self.config.setting['password'] = 'abc' # nosec
upgrade_to_v1_4_0_dev_2(self.config)
self.assertNotIn('username', self.config.setting)
self.assertNotIn('password', self.config.setting)
def test_upgrade_to_v1_4_0_dev_3(self):
ListOption("setting", "ca_providers", [])
self.config.setting['ca_provider_use_amazon'] = True
self.config.setting['ca_provider_use_caa'] = True
self.config.setting['ca_provider_use_whitelist'] = False
self.config.setting['ca_provider_use_caa_release_group_fallback'] = True
upgrade_to_v1_4_0_dev_3(self.config)
self.assertIn('ca_providers', self.config.setting)
self.assertIn(('Amazon', True), self.config.setting['ca_providers'])
self.assertIn(('Cover Art Archive', True), self.config.setting['ca_providers'])
self.assertIn(('Whitelist', False), self.config.setting['ca_providers'])
self.assertIn(('CaaReleaseGroup', True), self.config.setting['ca_providers'])
self.assertEqual(len(self.config.setting['ca_providers']), 4)
def test_upgrade_to_v1_4_0_dev_4(self):
TextOption("setting", "file_naming_format", "")
self.config.setting['file_naming_format'] = 'xxx'
upgrade_to_v1_4_0_dev_4(self.config)
self.assertEqual('xxx', self.config.setting['file_naming_format'])
self.config.setting['file_naming_format'] = OLD_DEFAULT_FILE_NAMING_FORMAT_v1_3
upgrade_to_v1_4_0_dev_4(self.config)
self.assertEqual(DEFAULT_FILE_NAMING_FORMAT, self.config.setting['file_naming_format'])
def test_upgrade_to_v1_4_0_dev_6(self):
BoolOption('setting', 'enable_tagger_scripts', False)
ListOption('setting', 'list_of_scripts', [])
self.config.setting['enable_tagger_script'] = True
self.config.setting['tagger_script'] = "abc"
upgrade_to_v1_4_0_dev_6(self.config)
self.assertNotIn('enable_tagger_script', self.config.setting)
self.assertNotIn('tagger_script', self.config.setting)
self.assertTrue(self.config.setting['enable_tagger_scripts'])
self.assertEqual([(0, unique_numbered_title(DEFAULT_SCRIPT_NAME, []), True, 'abc')], self.config.setting['list_of_scripts'])
def test_upgrade_to_v1_4_0_dev_7(self):
BoolOption('setting', 'embed_only_one_front_image', False)
self.config.setting['save_only_front_images_to_tags'] = True
upgrade_to_v1_4_0_dev_7(self.config)
self.assertNotIn('save_only_front_images_to_tags', self.config.setting)
self.assertTrue(self.config.setting['embed_only_one_front_image'])
def test_upgrade_to_v2_0_0_dev_3(self):
IntOption("setting", "caa_image_size", 500)
self.config.setting['caa_image_size'] = 0
upgrade_to_v2_0_0_dev_3(self.config)
self.assertEqual(250, self.config.setting['caa_image_size'])
self.config.setting['caa_image_size'] = 501
upgrade_to_v2_0_0_dev_3(self.config)
self.assertEqual(501, self.config.setting['caa_image_size'])
def test_upgrade_to_v2_1_0_dev_1(self):
BoolOption("setting", "use_genres", False)
IntOption("setting", "max_genres", 5)
IntOption("setting", "min_genre_usage", 90)
TextOption("setting", "ignore_genres", "seen live, favorites, fixme, owned")
TextOption("setting", "join_genres", "")
BoolOption("setting", "only_my_genres", False)
BoolOption("setting", "artists_genres", False)
BoolOption("setting", "folksonomy_tags", False)
self.config.setting['folksonomy_tags'] = True
self.config.setting['max_tags'] = 6
self.config.setting['min_tag_usage'] = 85
self.config.setting['ignore_tags'] = "abc"
self.config.setting['join_tags'] = "abc"
self.config.setting['only_my_tags'] = True
self.config.setting['artists_tags'] = True
upgrade_to_v2_1_0_dev_1(self.config)
self.assertEqual(self.config.setting['use_genres'], True)
self.assertEqual(self.config.setting['max_genres'], 6)
self.assertEqual(self.config.setting['min_genre_usage'], 85)
self.assertEqual(self.config.setting['ignore_genres'], "abc")
self.assertEqual(self.config.setting['join_genres'], "abc")
self.assertEqual(self.config.setting['only_my_genres'], True)
self.assertEqual(self.config.setting['artists_genres'], True)
self.assertIn('folksonomy_tags', self.config.setting)
self.assertNotIn('max_tags', self.config.setting)
self.assertNotIn('min_tag_usage', self.config.setting)
self.assertNotIn('ignore_tags', self.config.setting)
self.assertNotIn('join_tags', self.config.setting)
self.assertNotIn('only_my_tags', self.config.setting)
self.assertNotIn('artists_tags', self.config.setting)
def test_upgrade_to_v2_2_0_dev_3(self):
TextOption("setting", "ignore_genres", "")
TextOption("setting", "genres_filter", "")
self.config.setting['ignore_genres'] = "a, b,c"
upgrade_to_v2_2_0_dev_3(self.config)
self.assertNotIn('ignore_genres', self.config.setting)
self.assertEqual(self.config.setting['genres_filter'], "-a\n-b\n-c")
def test_upgrade_to_v2_2_0_dev_4(self):
TextOption("setting", "file_naming_format", "")
self.config.setting['file_naming_format'] = 'xxx'
upgrade_to_v2_2_0_dev_4(self.config)
self.assertEqual('xxx', self.config.setting['file_naming_format'])
self.config.setting['file_naming_format'] = OLD_DEFAULT_FILE_NAMING_FORMAT_v2_1
upgrade_to_v2_2_0_dev_4(self.config)
self.assertEqual(DEFAULT_FILE_NAMING_FORMAT, self.config.setting['file_naming_format'])
def test_upgrade_to_v2_4_0_beta_3(self):
ListOption("setting", "preserved_tags", [])
self.config.setting['preserved_tags'] = 'foo,bar'
upgrade_to_v2_4_0_beta_3(self.config)
self.assertEqual(['foo', 'bar'], self.config.setting['preserved_tags'])
def test_upgrade_to_v2_4_0_beta_3_already_done(self):
ListOption("setting", "preserved_tags", [])
self.config.setting['preserved_tags'] = ['foo', 'bar']
upgrade_to_v2_4_0_beta_3(self.config)
self.assertEqual(['foo', 'bar'], self.config.setting['preserved_tags'])
def test_upgrade_to_v2_5_0_dev_1(self):
ListOption("setting", "ca_providers", [])
self.config.setting['ca_providers'] = [
('Cover Art Archive', True),
('Whitelist', True),
('Local', False),
]
expected = [
('Cover Art Archive', True),
('UrlRelationships', True),
('Local', False),
]
upgrade_to_v2_5_0_dev_1(self.config)
self.assertEqual(expected, self.config.setting['ca_providers'])
def test_upgrade_to_v2_5_0_dev_2(self):
Option("persist", "splitter_state", QByteArray())
Option("persist", "bottom_splitter_state", QByteArray())
self.config.persist["splitter_state"] = b'foo'
self.config.persist["bottom_splitter_state"] = b'bar'
upgrade_to_v2_5_0_dev_2(self.config)
self.assertEqual(b'', self.config.persist['splitter_state'])
self.assertEqual(b'', self.config.persist['bottom_splitter_state'])
def test_upgrade_to_v2_6_0_dev_1(self):
TextOption("setting", "acoustid_fpcalc", "")
self.config.setting["acoustid_fpcalc"] = "/usr/bin/fpcalc"
upgrade_to_v2_6_0_dev_1(self.config)
self.assertEqual("/usr/bin/fpcalc", self.config.setting["acoustid_fpcalc"])
def test_upgrade_to_v2_6_0_dev_1_empty(self):
TextOption("setting", "acoustid_fpcalc", "")
self.config.setting["acoustid_fpcalc"] = None
upgrade_to_v2_6_0_dev_1(self.config)
self.assertEqual("", self.config.setting["acoustid_fpcalc"])
def test_upgrade_to_v2_6_0_dev_1_snap(self):
TextOption("setting", "acoustid_fpcalc", "")
self.config.setting["acoustid_fpcalc"] = "/snap/picard/221/usr/bin/fpcalc"
upgrade_to_v2_6_0_dev_1(self.config)
self.assertEqual("", self.config.setting["acoustid_fpcalc"])
def test_upgrade_to_v2_6_0_dev_1_frozen(self):
TextOption("setting", "acoustid_fpcalc", "")
self.config.setting["acoustid_fpcalc"] = r"C:\Program Files\MusicBrainz Picard\fpcalc.exe"
picard.config_upgrade.IS_FROZEN = True
upgrade_to_v2_6_0_dev_1(self.config)
picard.config_upgrade.IS_FROZEN = False
self.assertEqual("", self.config.setting["acoustid_fpcalc"])
def test_upgrade_to_v2_6_0_beta_2(self):
BoolOption('setting', 'image_type_as_filename', False)
BoolOption('setting', 'save_only_one_front_image', False)
self.config.setting['caa_image_type_as_filename'] = True
self.config.setting['caa_save_single_front_image'] = True
upgrade_to_v2_6_0_beta_2(self.config)
self.assertNotIn('caa_image_type_as_filename', self.config.setting)
self.assertTrue(self.config.setting['image_type_as_filename'])
self.assertNotIn('caa_save_single_front_image', self.config.setting)
self.assertTrue(self.config.setting['save_only_one_front_image'])
def test_upgrade_to_v2_6_0_beta_3(self):
from picard.ui.theme import UiTheme
BoolOption('setting', 'use_system_theme', False)
self.config.setting['use_system_theme'] = True
upgrade_to_v2_6_0_beta_3(self.config)
self.assertNotIn('use_system_theme', self.config.setting)
self.assertIn('ui_theme', self.config.setting)
self.assertEqual(str(UiTheme.SYSTEM), self.config.setting['ui_theme'])
def test_upgrade_to_v2_8_0_dev_2(self):
ListOption('setting', 'toolbar_layout', [])
self.config.setting['toolbar_layout'] = [
'add_directory_action',
'extract_and_submit_acousticbrainz_features_action',
'save_action'
]
expected = ['add_directory_action', 'save_action']
upgrade_to_v2_8_0_dev_2(self.config)
self.assertEqual(expected, self.config.setting['toolbar_layout'])
upgrade_to_v2_8_0_dev_2(self.config)
self.assertEqual(expected, self.config.setting['toolbar_layout'])
Reference in New Issue View Git Blame Copy Permalink