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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" Tests the 'ETSConfig' configuration object. """
# Standard library imports.
import contextlib
import os
import pathlib
import shutil
import sys
import tempfile
import time
import unittest
from unittest.mock import patch
# Enthought library imports.
from traits.etsconfig.etsconfig import ETSConfig, ETSToolkitError
@contextlib.contextmanager
def temporary_directory():
"""
Context manager to create and clean up a temporary directory.
"""
temp_dir = tempfile.mkdtemp()
try:
yield temp_dir
finally:
shutil.rmtree(temp_dir)
@contextlib.contextmanager
def restore_mapping_entry(mapping, key):
"""
Context manager that restores a mapping entry to its previous
state on exit.
"""
missing = object()
old_value = mapping.get(key, missing)
try:
yield
finally:
if old_value is missing:
mapping.pop(key, None)
else:
mapping[key] = old_value
@contextlib.contextmanager
def temporary_home_directory():
"""
Context manager that temporarily remaps HOME / APPDATA
to a temporary directory.
"""
# Use the same recipe as in ETSConfig._initialize_application_data
# to determine the home directory.
home_var = "APPDATA" if sys.platform == "win32" else "HOME"
with temporary_directory() as temp_home:
with restore_mapping_entry(os.environ, home_var):
os.environ[home_var] = temp_home
yield temp_home
@contextlib.contextmanager
def mock_sys_argv(args):
old_args = sys.argv
sys.argv = args
try:
yield
finally:
sys.argv = old_args
@contextlib.contextmanager
def mock_os_environ(args):
old_environ = os.environ
os.environ = args
try:
yield
finally:
os.environ = old_environ
class ETSConfigTestCase(unittest.TestCase):
""" Tests the 'ETSConfig' configuration object. """
###########################################################################
# 'TestCase' interface.
###########################################################################
#### public methods #######################################################
def setUp(self):
"""
Prepares the test fixture before each test method is called.
"""
# Make a fresh instance each time.
self.ETSConfig = type(ETSConfig)()
with contextlib.ExitStack() as stack:
self._temp_home = stack.enter_context(temporary_home_directory())
self.addCleanup(stack.pop_all().close)
###########################################################################
# 'ETSConfigTestCase' interface.
###########################################################################
#### public methods #######################################################
def test_application_data(self):
"""
application data
"""
dirname = self.ETSConfig.application_data
self.assertEqual(os.path.exists(dirname), True)
self.assertEqual(os.path.isdir(dirname), True)
def test_set_application_data(self):
"""
set application data
"""
old = self.ETSConfig.application_data
self.ETSConfig.application_data = "foo"
self.assertEqual("foo", self.ETSConfig.application_data)
self.ETSConfig.application_data = old
self.assertEqual(old, self.ETSConfig.application_data)
def test_delete_application_data(self):
default_application_data = self.ETSConfig.application_data
self.ETSConfig.application_data = "SomeOtherPath"
del self.ETSConfig.application_data
self.assertEqual(
self.ETSConfig.application_data,
default_application_data,
)
def test_mock_application_data(self):
# given
old_app_data = self.ETSConfig.application_data
# when
with patch.object(self.ETSConfig, "application_data", new="foo"):
# then
self.assertEqual(self.ETSConfig.application_data, "foo")
# then
self.assertEqual(self.ETSConfig.application_data, old_app_data)
def test_application_data_is_idempotent(self):
"""
application data is idempotent
"""
# Just do the previous test again!
self.test_application_data()
self.test_application_data()
def test_write_to_application_data_directory(self):
"""
write to application data directory
"""
self.ETSConfig.company = "Blah"
dirname = self.ETSConfig.application_data
path = os.path.join(dirname, "dummy.txt")
data = str(time.time())
with open(path, "w", encoding="utf-8") as f:
f.write(data)
self.assertEqual(os.path.exists(path), True)
with open(path, "r", encoding="utf-8") as f:
result = f.read()
os.remove(path)
self.assertEqual(data, result)
def test_default_company(self):
"""
default company
"""
self.assertEqual(self.ETSConfig.company, "Enthought")
def test_set_company(self):
"""
set company
"""
old = self.ETSConfig.company
self.ETSConfig.company = "foo"
self.assertEqual("foo", self.ETSConfig.company)
self.ETSConfig.company = old
self.assertEqual(old, self.ETSConfig.company)
def test_delete_company(self):
default_company = self.ETSConfig.company
self.ETSConfig.company = "ImaginaryCo"
# Deletion restores the default
del self.ETSConfig.company
self.assertEqual(self.ETSConfig.company, default_company)
def test_mock_company(self):
# given
old_company = self.ETSConfig.company
# when
with patch.object(self.ETSConfig, "company", new="new company"):
# then
self.assertEqual(self.ETSConfig.company, "new company")
# then
self.assertEqual(self.ETSConfig.company, old_company)
def test_default_application_home(self):
"""
application home
"""
app_home = self.ETSConfig.application_home
(dirname, app_name) = os.path.split(app_home)
self.assertEqual(dirname, self.ETSConfig.application_data)
self.assertEqual(
app_name,
pathlib.Path(sys.modules["__main__"].__file__).parts[-2]
)
def test_delete_application_home(self):
# given
default_application_home = self.ETSConfig.application_home
self.ETSConfig.application_home = "dummy"
self.assertEqual(self.ETSConfig.application_home, "dummy")
# check that the property can be deleted
del self.ETSConfig.application_home
self.assertEqual(
self.ETSConfig.application_home,
default_application_home,
)
def test_mock_application_home(self):
# given
old_app_home = self.ETSConfig.application_home
# when
with patch.object(self.ETSConfig, "application_home", new="foo"):
# then
self.assertEqual(self.ETSConfig.application_home, "foo")
# then
self.assertEqual(self.ETSConfig.application_home, old_app_home)
def test_toolkit_default_kiva_backend(self):
self.ETSConfig.toolkit = "qt4"
self.assertEqual(self.ETSConfig.kiva_backend, "image")
def test_default_backend_for_qt5_toolkit(self):
self.ETSConfig.toolkit = "qt"
self.assertEqual(self.ETSConfig.kiva_backend, "image")
def test_toolkit_explicit_kiva_backend(self):
self.ETSConfig.toolkit = "wx.celiagg"
self.assertEqual(self.ETSConfig.kiva_backend, "celiagg")
def test_toolkit_kiva_backend_changes_when_toolkit_changed(self):
self.ETSConfig.toolkit = "wx.celiagg"
self.assertEqual(self.ETSConfig.kiva_backend, "celiagg")
del self.ETSConfig.toolkit
self.ETSConfig.toolkit = "wx.quartz"
self.assertEqual(self.ETSConfig.kiva_backend, "quartz")
def test_mock_kiva_backend(self):
# when
with patch.object(self.ETSConfig, "toolkit", new="test.foo"):
# then
self.assertEqual(self.ETSConfig.kiva_backend, "foo")
def test_toolkit_environ(self):
test_args = ["something"]
test_environ = {"ETS_TOOLKIT": "test"}
with mock_sys_argv(test_args):
with mock_os_environ(test_environ):
toolkit = self.ETSConfig.toolkit
self.assertEqual(toolkit, "test")
def test_toolkit_environ_missing(self):
test_args = ["something"]
test_environ = {}
with mock_sys_argv(test_args):
with mock_os_environ(test_environ):
toolkit = self.ETSConfig.toolkit
self.assertEqual(toolkit, "")
def test_set_toolkit(self):
test_args = []
test_environ = {"ETS_TOOLKIT": "test_environ"}
with mock_sys_argv(test_args):
with mock_os_environ(test_environ):
self.ETSConfig.toolkit = "test_direct"
toolkit = self.ETSConfig.toolkit
self.assertEqual(toolkit, "test_direct")
def test_delete_toolkit(self):
default_toolkit = self.ETSConfig.toolkit
del self.ETSConfig.toolkit
self.assertEqual(self.ETSConfig.toolkit, default_toolkit)
def test_mock_toolkit(self):
# given
old_toolkit = self.ETSConfig.toolkit
# when
with patch.object(self.ETSConfig, "toolkit", new="foo"):
# then
self.assertEqual(self.ETSConfig.toolkit, "foo")
# then
self.assertEqual(self.ETSConfig.toolkit, old_toolkit)
def test_provisional_toolkit(self):
test_args = []
test_environ = {}
with mock_sys_argv(test_args):
with mock_os_environ(test_environ):
repr(self.ETSConfig.toolkit)
with self.ETSConfig.provisional_toolkit("test_direct"):
toolkit = self.ETSConfig.toolkit
self.assertEqual(toolkit, "test_direct")
# should stay set, since no exception raised
toolkit = self.ETSConfig.toolkit
self.assertEqual(toolkit, "test_direct")
def test_provisional_toolkit_exception(self):
test_args = []
test_environ = {"ETS_TOOLKIT": ""}
with mock_sys_argv(test_args):
with mock_os_environ(test_environ):
try:
with self.ETSConfig.provisional_toolkit("test_direct"):
toolkit = self.ETSConfig.toolkit
self.assertEqual(toolkit, "test_direct")
raise ETSToolkitError("Test exception")
except ETSToolkitError as exc:
if not exc.message == "Test exception":
raise
# should be reset, since exception raised
toolkit = self.ETSConfig.toolkit
self.assertEqual(toolkit, "")
def test_provisional_toolkit_already_set(self):
test_args = []
test_environ = {"ETS_TOOLKIT": "test_environ"}
with mock_sys_argv(test_args):
with mock_os_environ(test_environ):
with self.assertRaises(ETSToolkitError):
with self.ETSConfig.provisional_toolkit("test_direct"):
pass
# should come from the environment
toolkit = self.ETSConfig.toolkit
self.assertEqual(toolkit, "test_environ")
def test_user_data(self):
"""
user data
"""
dirname = self.ETSConfig.user_data
self.assertEqual(os.path.exists(dirname), True)
self.assertEqual(os.path.isdir(dirname), True)
def test_set_user_data(self):
"""
set user data
"""
old = self.ETSConfig.user_data
self.ETSConfig.user_data = "foo"
self.assertEqual("foo", self.ETSConfig.user_data)
self.ETSConfig.user_data = old
self.assertEqual(old, self.ETSConfig.user_data)
def test_delete_user_data(self):
default_user_data = self.ETSConfig.user_data
self.ETSConfig.user_data = "SomeOtherPath"
del self.ETSConfig.user_data
self.assertEqual(self.ETSConfig.user_data, default_user_data)
def test_mock_user_data(self):
# given
old_user_data = self.ETSConfig.user_data
# when
with patch.object(self.ETSConfig, "user_data", new="foo"):
# then
self.assertEqual(self.ETSConfig.user_data, "foo")
# then
self.assertEqual(self.ETSConfig.user_data, old_user_data)
def test_user_data_is_idempotent(self):
"""
user data is idempotent
"""
# Just do the previous test again!
self.test_user_data()
def test_write_to_user_data_directory(self):
"""
write to user data directory
"""
self.ETSConfig.company = "Blah"
dirname = self.ETSConfig.user_data
path = os.path.join(dirname, "dummy.txt")
data = str(time.time())
with open(path, "w", encoding="utf-8") as f:
f.write(data)
self.assertEqual(os.path.exists(path), True)
with open(path, "r", encoding="utf-8") as f:
result = f.read()
os.remove(path)
self.assertEqual(data, result)
|
