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
|
# vim: ts=4:sw=4:expandtab
# BleachBit
# Copyright (C) 2008-2025 Andrew Ziem
# https://www.bleachbit.org
#
# 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 3 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, see <http://www.gnu.org/licenses/>.
"""
Test case for module Options
"""
import errno
import os
from unittest import mock
from tests import common
import bleachbit.Options
from bleachbit import NoOptionError
class OptionsTestCase(common.BleachbitTestCase):
"""Test case for class Options"""
def test_Options(self):
"""Unit test for class Options"""
o = bleachbit.Options.options
value = o.get("check_online_updates")
# toggle a boolean
o.toggle('check_online_updates')
self.assertEqual(not value, o.get("check_online_updates"))
# restore original boolean
o.set("check_online_updates", value)
self.assertEqual(value, o.get("check_online_updates"))
# test auto commit
shred = o.get("shred")
o.set("shred", False)
self.assertFalse(o.get("shred"))
o.set("shred", True, commit=False)
self.assertTrue(o.get("shred"))
o.restore()
self.assertFalse(o.get("shred"))
o.set("shred", shred)
self.assertEqual(o.get("shred"), shred)
# try a list
list_values = ['a', 'b', 'c']
o.set_list("list_test", list_values)
self.assertEqual(list_values, o.get_list("list_test"))
# these should always be set
for bkey in bleachbit.Options.boolean_keys:
self.assertIsInstance(o.get(bkey), bool)
# language
value = o.get_language('en')
self.assertIsInstance(value, bool)
o.set_language('en', True)
self.assertTrue(o.get_language('en'))
o.set_language('en', False)
self.assertFalse(o.get_language('en'))
o.set_language('en', value)
# tree
o.set_tree("parent", "child", True)
self.assertTrue(o.get_tree("parent", "child"))
o.set_tree("parent", "child", False)
self.assertFalse(o.get_tree("parent", "child"))
o.config.remove_option("tree", "parent.child")
self.assertFalse(o.get_tree("parent", "child"))
# clean up
del o
def test_whitelist(self):
"""Test for get_whitelist_paths() / set_whitelist_paths()"""
o = bleachbit.Options.options
self.assertIsInstance(o.get_whitelist_paths(), list)
whitelist = [('file', '/home/foo'), ('folder', '/home'),
('file', '/home/unicode/кодирование')]
old_whitelist = o.get_whitelist_paths()
o.config.remove_section('whitelist/paths')
self.assertIsInstance(o.get_whitelist_paths(), list)
self.assertEqual(o.get_whitelist_paths(), [])
o.set_whitelist_paths(whitelist)
self.assertIsInstance(o.get_whitelist_paths(), list)
self.assertEqual(set(whitelist), set(o.get_whitelist_paths()))
o.set_whitelist_paths(old_whitelist)
self.assertEqual(set(old_whitelist), set(o.get_whitelist_paths()))
def test_init_configuration(self):
"""Test for init_configuration()"""
if os.path.exists(bleachbit.options_file):
os.remove(bleachbit.options_file)
self.assertNotExists(bleachbit.options_file)
bleachbit.Options.init_configuration()
self.assertExists(bleachbit.options_file)
def test_is_corrupt(self):
"""Test is_corrupt()"""
def _test_is_corrupt(contents, expect_is_corrupt):
with open(bleachbit.options_file, 'w') as f:
f.write(contents)
o = bleachbit.Options.Options()
self.assertEqual(o.is_corrupt(), expect_is_corrupt)
# test blank
_test_is_corrupt('', False)
_test_is_corrupt('[bleachbit]\n', False)
# test valid but non-standard boolean
_test_is_corrupt('[bleachbit]\nshred=f\n', False)
# test invalid boolean
# https://github.com/bleachbit/bleachbit/issues/560#issuecomment-497361700
_test_is_corrupt("[bleachbit]\nshred=['True']\n", True)
os.remove(bleachbit.options_file)
def test_purge(self):
"""Test purging"""
# By default ConfigParser stores keys (the filenames) as lowercase.
# This needs special consideration when combined with purging.
o1 = bleachbit.Options.Options()
pathname = self.write_file('foo.xml')
myhash = '0ABCD'
o1.set_hashpath(pathname, myhash)
self.assertEqual(myhash, o1.get_hashpath(pathname))
if 'nt' == os.name:
# check case sensitivity
self.assertEqual(myhash, o1.get_hashpath(pathname.upper()))
del o1
# reopen
o2 = bleachbit.Options.Options()
# write something, which triggers the purge
o2.set('dummypath', 'dummyvalue', 'hashpath')
# verify the path was not purged
self.assertTrue(os.path.exists(pathname))
self.assertEqual(myhash, o2.get_hashpath(pathname))
# delete the path
os.remove(pathname)
# close and reopen
del o2
o3 = bleachbit.Options.Options()
# write something, which triggers the purge
o3.set('dummypath', 'dummyvalue', 'hashpath')
# verify the path was purged
self.assertRaises(NoOptionError, lambda: o3.get_hashpath(pathname))
def test_abbreviations(self):
"""Test non-standard, abbreviated booleans T and F"""
# set values
o = bleachbit.Options.options
if not o.config.has_section('test'):
o.config.add_section('test')
o.config.set('test', 'test_t_upper', 'T')
o.config.set('test', 'test_f_upper', 'F')
o.config.set('test', 'test_t_lower', 't')
o.config.set('test', 'test_f_lower', 'f')
# read
self.assertEqual(o.config.getboolean('test', 'test_t_upper'), True)
self.assertEqual(o.config.getboolean('test', 'test_t_lower'), True)
self.assertEqual(o.config.getboolean('test', 'test_f_upper'), False)
self.assertEqual(o.config.getboolean('test', 'test_f_lower'), False)
# clean up
del o
def test_percent(self):
"""Test that the percent sign can be used without quoting the string"""
# https://github.com/bleachbit/bleachbit/issues/205
opt = bleachbit.Options.options.config
if not opt.has_section('test'):
opt.add_section('test')
opt.set('test', 'filename', '/var/log/samba/log.%m')
# read
self.assertEqual(opt.get('test', 'filename'), '/var/log/samba/log.%m')
# clean up
del opt
def test_error_disk_full(self):
"""Test graceful degradation when disk is full"""
disk_full_error = OSError('No space left on device')
disk_full_error.errno = errno.ENOSPC
o = bleachbit.Options.Options()
with mock.patch('builtins.open', side_effect=disk_full_error):
with self.assertLogs(level='ERROR') as log_context:
o.set('test_key', 'test_value')
self.assertIn('Disk was full', log_context.output[0])
self.assertIn(bleachbit.options_file, log_context.output[0])
self.assertEqual(o.get('test_key'), 'test_value')
def test_error_permission(self):
"""Test graceful degradation with permission errors"""
permission_error = PermissionError('Permission denied')
permission_error.errno = errno.EACCES
o = bleachbit.Options.Options()
with mock.patch('builtins.open', side_effect=permission_error):
with self.assertLogs(level='ERROR') as log_context:
o.set('test_key', 'test_value')
self.assertIn('Permission denied', log_context.output[0])
self.assertIn(bleachbit.options_file, log_context.output[0])
self.assertEqual(o.get('test_key'), 'test_value')
|
