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
|
# -*- coding: utf-8 -*-
#
# Picard, the next-generation MusicBrainz tagger
#
# Copyright (C) 2021 Bob Swift
# Copyright (C) 2022 Philipp Wolfer
#
# 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 logging
import os
import shutil
from test.picardtestcase import PicardTestCase
from picard.config import (
BoolOption,
Config,
IntOption,
ListOption,
Option,
SettingConfigSection,
TextOption,
)
from picard.profile import UserProfileGroups
class TestPicardProfilesCommon(PicardTestCase):
PROFILES_KEY = SettingConfigSection.PROFILES_KEY
SETTINGS_KEY = SettingConfigSection.SETTINGS_KEY
def setUp(self):
super().setUp()
self.tmp_directory = self.mktmpdir()
self.configpath = os.path.join(self.tmp_directory, 'test.ini')
shutil.copy(os.path.join('test', 'data', 'test.ini'), self.configpath)
self.addCleanup(os.remove, self.configpath)
self.config = Config.from_file(None, self.configpath)
self.addCleanup(self.cleanup_config_obj)
self.config.application["version"] = "testing"
logging.disable(logging.ERROR)
Option.registry = {}
ListOption('profiles', self.PROFILES_KEY, [])
Option('profiles', self.SETTINGS_KEY, {})
# Get valid profile option settings for testing
option_settings = list(UserProfileGroups.ALL_SETTINGS)
self.test_setting_0 = option_settings[0]
self.test_setting_1 = option_settings[1]
self.test_setting_2 = option_settings[2]
self.test_setting_3 = option_settings[3]
TextOption("setting", self.test_setting_0, "abc")
BoolOption("setting", self.test_setting_1, True)
IntOption("setting", self.test_setting_2, 42)
TextOption("setting", self.test_setting_3, "xyz")
def cleanup_config_obj(self):
# Ensure QSettings do not recreate the file on exit
self.config.sync()
del self.config
self.config = None
def get_profiles(self, enabled=True):
profiles = []
for i in range(3):
profiles.append(
{
"position": i,
"title": "Test Profile {0}".format(i),
"enabled": enabled,
"id": "test_key_{0}".format(i),
}
)
return profiles
class TestUserProfileGroups(PicardTestCase):
def test_has_groups(self):
keys = list(UserProfileGroups.get_setting_groups_list())
self.assertNotEqual(keys, [])
def test_groups_have_items(self):
for key in UserProfileGroups.get_setting_groups_list():
settings = UserProfileGroups.SETTINGS_GROUPS[key]["settings"]
self.assertNotEqual(settings, {})
def test_no_duplicate_settings(self):
count1 = 0
for key in UserProfileGroups.get_setting_groups_list():
settings = UserProfileGroups.SETTINGS_GROUPS[key]["settings"]
count1 += len(settings)
count2 = len(UserProfileGroups.ALL_SETTINGS)
self.assertEqual(count1, count2)
def test_settings_have_no_blank_keys(self):
for key in UserProfileGroups.get_setting_groups_list():
settings = UserProfileGroups.SETTINGS_GROUPS[key]["settings"]
for key, title, fields in settings:
self.assertNotEqual(key.strip(), "")
def test_settings_have_titles(self):
for key in UserProfileGroups.get_setting_groups_list():
settings = UserProfileGroups.SETTINGS_GROUPS[key]["settings"]
self.assertNotEqual(settings, {})
for key, title, fields in settings:
self.assertNotEqual(title.strip(), "")
class TestUserProfiles(TestPicardProfilesCommon):
def test_settings(self):
self.config.setting[self.test_setting_0] = "abc"
self.config.setting[self.test_setting_1] = True
self.config.setting[self.test_setting_2] = 42
settings = {
"test_key_0": {self.test_setting_0: None},
"test_key_1": {self.test_setting_1: None},
"test_key_2": {self.test_setting_2: None},
}
self.config.profiles[self.SETTINGS_KEY] = settings
self.config.profiles[self.PROFILES_KEY] = self.get_profiles(enabled=True)
# Stack:
# setting_0 setting_1 setting_2
# --------- --------- ---------
# test_key_0: None n/a n/a
# test_key_1: n/a None n/a
# test_key_2: n/a n/a None
# user_settings: abc True 42
# Test retrieval with overrides at None
self.assertEqual(self.config.setting[self.test_setting_0], "abc")
self.assertEqual(self.config.setting[self.test_setting_1], True)
self.assertEqual(self.config.setting[self.test_setting_2], 42)
# Test setting new values
self.config.setting[self.test_setting_0] = "def"
self.config.setting[self.test_setting_1] = False
self.config.setting[self.test_setting_2] = 99
# Stack:
# setting_0 setting_1 setting_2
# --------- --------- ---------
# test_key_0: def n/a n/a
# test_key_1: n/a False n/a
# test_key_2: n/a n/a 99
# user_settings: abc True 42
self.assertEqual(self.config.setting[self.test_setting_0], "def")
self.assertEqual(self.config.setting[self.test_setting_1], False)
self.assertEqual(self.config.setting[self.test_setting_2], 99)
# Test retrieval with profiles disabled
self.config.profiles[self.PROFILES_KEY] = self.get_profiles(enabled=False)
self.assertEqual(self.config.setting[self.test_setting_0], "abc")
self.assertEqual(self.config.setting[self.test_setting_1], True)
self.assertEqual(self.config.setting[self.test_setting_2], 42)
# Test setting new values with profiles disabled
self.config.setting[self.test_setting_0] = "ghi"
self.config.setting[self.test_setting_1] = True
self.config.setting[self.test_setting_2] = 86
# Stack:
# setting_0 setting_1 setting_2
# --------- --------- ---------
# test_key_0: def n/a n/a
# test_key_1: n/a False n/a
# test_key_2: n/a n/a 99
# user_settings: ghi True 86
self.assertEqual(self.config.setting[self.test_setting_0], "ghi")
self.assertEqual(self.config.setting[self.test_setting_1], True)
self.assertEqual(self.config.setting[self.test_setting_2], 86)
# Re-enable profiles and check that the saved settings still exist
self.config.profiles[self.PROFILES_KEY] = self.get_profiles(enabled=True)
self.assertEqual(self.config.setting[self.test_setting_0], "def")
self.assertEqual(self.config.setting[self.test_setting_1], False)
self.assertEqual(self.config.setting[self.test_setting_2], 99)
def test_settings_with_overrides(self):
self.config.setting[self.test_setting_0] = "abc"
self.config.setting[self.test_setting_1] = True
self.config.setting[self.test_setting_2] = 42
settings = {
"test_key_0": {self.test_setting_0: None},
"test_key_1": {self.test_setting_1: None},
"test_key_2": {self.test_setting_2: None},
}
self.config.profiles[self.SETTINGS_KEY] = settings
self.config.profiles[self.PROFILES_KEY] = self.get_profiles(enabled=False)
self.config.setting.set_profiles_override(self.get_profiles(enabled=True))
# Stack:
# setting_0 setting_1 setting_2
# --------- --------- ---------
# test_key_0: None n/a n/a
# test_key_1: n/a None n/a
# test_key_2: n/a n/a None
# user_settings: abc True 42
# Test retrieval with overrides at None
self.assertEqual(self.config.setting[self.test_setting_0], "abc")
self.assertEqual(self.config.setting[self.test_setting_1], True)
self.assertEqual(self.config.setting[self.test_setting_2], 42)
# Test setting new values
self.config.setting[self.test_setting_0] = "def"
self.config.setting[self.test_setting_1] = False
self.config.setting[self.test_setting_2] = 99
# Stack:
# setting_0 setting_1 setting_2
# --------- --------- ---------
# test_key_0: def n/a n/a
# test_key_1: n/a False n/a
# test_key_2: n/a n/a 99
# user_settings: abc True 42
self.assertEqual(self.config.setting[self.test_setting_0], "def")
self.assertEqual(self.config.setting[self.test_setting_1], False)
self.assertEqual(self.config.setting[self.test_setting_2], 99)
# Test retrieval with profile overrides disabled
self.config.setting.set_profiles_override()
self.assertEqual(self.config.setting[self.test_setting_0], "abc")
self.assertEqual(self.config.setting[self.test_setting_1], True)
self.assertEqual(self.config.setting[self.test_setting_2], 42)
# Test retrieval with empty settings overrides
self.config.setting.set_profiles_override(self.get_profiles(enabled=True))
empty_settings = {
"test_key_0": {},
"test_key_1": {},
"test_key_2": {},
}
self.config.setting.set_settings_override(empty_settings)
self.assertEqual(self.config.setting[self.test_setting_0], "abc")
self.assertEqual(self.config.setting[self.test_setting_1], True)
self.assertEqual(self.config.setting[self.test_setting_2], 42)
# Test retrieval with settings overrides disabled
self.config.setting.set_settings_override()
self.assertEqual(self.config.setting[self.test_setting_0], "def")
self.assertEqual(self.config.setting[self.test_setting_1], False)
self.assertEqual(self.config.setting[self.test_setting_2], 99)
# Test setting new values with profiles override disabled
self.config.setting.set_profiles_override()
self.config.setting[self.test_setting_0] = "ghi"
self.config.setting[self.test_setting_1] = True
self.config.setting[self.test_setting_2] = 86
# Stack:
# setting_0 setting_1 setting_2
# --------- --------- ---------
# test_key_0: def n/a n/a
# test_key_1: n/a False n/a
# test_key_2: n/a n/a 99
# user_settings: ghi True 86
self.assertEqual(self.config.setting[self.test_setting_0], "ghi")
self.assertEqual(self.config.setting[self.test_setting_1], True)
self.assertEqual(self.config.setting[self.test_setting_2], 86)
# Re-enable profile overrides and check that the saved settings still exist
self.config.setting.set_profiles_override(self.get_profiles(enabled=True))
self.assertEqual(self.config.setting[self.test_setting_0], "def")
self.assertEqual(self.config.setting[self.test_setting_1], False)
self.assertEqual(self.config.setting[self.test_setting_2], 99)
# Re-enable profile overrides and check that the saved settings still exist
# with invalid profile id in profile list
profiles = [
{
"position": 4,
"title": "Test Profile 4",
"enabled": True,
"id": "test_key_4",
}
]
profiles.extend(self.get_profiles(enabled=True))
self.config.setting.set_profiles_override(profiles)
self.assertEqual(self.config.setting[self.test_setting_0], "def")
self.assertEqual(self.config.setting[self.test_setting_1], False)
self.assertEqual(self.config.setting[self.test_setting_2], 99)
def test_config_option_rename(self):
from picard.config_upgrade import rename_option
self.config.setting[self.test_setting_0] = "abc"
self.config.setting[self.test_setting_1] = True
self.config.setting[self.test_setting_2] = 42
settings = {
"test_key_0": {self.test_setting_0: None},
"test_key_1": {self.test_setting_1: None},
"test_key_2": {self.test_setting_2: None},
}
self.config.profiles[self.SETTINGS_KEY] = settings
self.config.profiles[self.PROFILES_KEY] = self.get_profiles(enabled=True)
self.config.setting[self.test_setting_0] = "def"
rename_option(self.config, self.test_setting_0, self.test_setting_3, TextOption, "")
self.assertEqual(self.config.setting[self.test_setting_3], "def")
self.config.profiles[self.PROFILES_KEY] = self.get_profiles(enabled=False)
self.assertEqual(self.config.setting[self.test_setting_3], "abc")
|
