1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
# -*- 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.
import os
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,
upgrade_to_v2_12_3_dev_1,
)
from picard.const import (
DEFAULT_FILE_NAMING_FORMAT,
DEFAULT_SCRIPT_NAME,
)
from picard.util import unique_numbered_title
from picard.ui.options.renaming_compat import DEFAULT_REPLACEMENT
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'])
def test_upgrade_to_v2_12_3_dev_1(self):
TextOption('setting', 'replace_dir_separator', DEFAULT_REPLACEMENT)
self.config.setting['replace_dir_separator'] = os.sep
upgrade_to_v2_12_3_dev_1(self.config)
self.assertEqual(DEFAULT_REPLACEMENT, self.config.setting['replace_dir_separator'])
if os.altsep:
self.config.setting['replace_dir_separator'] = os.altsep
upgrade_to_v2_12_3_dev_1(self.config)
self.assertEqual(DEFAULT_REPLACEMENT, self.config.setting['replace_dir_separator'])
|
