/
test_path.py
443 lines (364 loc) · 14.5 KB
/
test_path.py
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
# encoding: utf-8
"""Tests for IPython.utils.path.py"""
#-----------------------------------------------------------------------------
# Copyright (C) 2008 The IPython Development Team
#
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
from __future__ import with_statement
import os
import shutil
import sys
import tempfile
import StringIO
from os.path import join, abspath, split
import nose.tools as nt
from nose import with_setup
import IPython
from IPython.testing import decorators as dec
from IPython.testing.decorators import skip_if_not_win32, skip_win32
from IPython.testing.tools import make_tempfile
from IPython.utils import path, io
# Platform-dependent imports
try:
import _winreg as wreg
except ImportError:
#Fake _winreg module on none windows platforms
import new
sys.modules["_winreg"] = new.module("_winreg")
import _winreg as wreg
#Add entries that needs to be stubbed by the testing code
(wreg.OpenKey, wreg.QueryValueEx,) = (None, None)
#-----------------------------------------------------------------------------
# Globals
#-----------------------------------------------------------------------------
env = os.environ
TEST_FILE_PATH = split(abspath(__file__))[0]
TMP_TEST_DIR = tempfile.mkdtemp()
HOME_TEST_DIR = join(TMP_TEST_DIR, "home_test_dir")
XDG_TEST_DIR = join(HOME_TEST_DIR, "xdg_test_dir")
IP_TEST_DIR = join(HOME_TEST_DIR,'.ipython')
#
# Setup/teardown functions/decorators
#
def setup():
"""Setup testenvironment for the module:
- Adds dummy home dir tree
"""
# Do not mask exceptions here. In particular, catching WindowsError is a
# problem because that exception is only defined on Windows...
os.makedirs(IP_TEST_DIR)
os.makedirs(os.path.join(XDG_TEST_DIR, 'ipython'))
def teardown():
"""Teardown testenvironment for the module:
- Remove dummy home dir tree
"""
# Note: we remove the parent test dir, which is the root of all test
# subdirs we may have created. Use shutil instead of os.removedirs, so
# that non-empty directories are all recursively removed.
shutil.rmtree(TMP_TEST_DIR)
def setup_environment():
"""Setup testenvironment for some functions that are tested
in this module. In particular this functions stores attributes
and other things that we need to stub in some test functions.
This needs to be done on a function level and not module level because
each testfunction needs a pristine environment.
"""
global oldstuff, platformstuff
oldstuff = (env.copy(), os.name, path.get_home_dir, IPython.__file__, os.getcwd())
if os.name == 'nt':
platformstuff = (wreg.OpenKey, wreg.QueryValueEx,)
def teardown_environment():
"""Restore things that were remebered by the setup_environment function
"""
(oldenv, os.name, path.get_home_dir, IPython.__file__, old_wd) = oldstuff
os.chdir(old_wd)
reload(path)
for key in env.keys():
if key not in oldenv:
del env[key]
env.update(oldenv)
if hasattr(sys, 'frozen'):
del sys.frozen
if os.name == 'nt':
(wreg.OpenKey, wreg.QueryValueEx,) = platformstuff
# Build decorator that uses the setup_environment/setup_environment
with_environment = with_setup(setup_environment, teardown_environment)
@skip_if_not_win32
@with_environment
def test_get_home_dir_1():
"""Testcase for py2exe logic, un-compressed lib
"""
sys.frozen = True
#fake filename for IPython.__init__
IPython.__file__ = abspath(join(HOME_TEST_DIR, "Lib/IPython/__init__.py"))
home_dir = path.get_home_dir()
nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
@skip_if_not_win32
@with_environment
def test_get_home_dir_2():
"""Testcase for py2exe logic, compressed lib
"""
sys.frozen = True
#fake filename for IPython.__init__
IPython.__file__ = abspath(join(HOME_TEST_DIR, "Library.zip/IPython/__init__.py")).lower()
home_dir = path.get_home_dir()
nt.assert_equal(home_dir, abspath(HOME_TEST_DIR).lower())
@with_environment
@skip_win32
def test_get_home_dir_3():
"""Testcase $HOME is set, then use its value as home directory."""
env["HOME"] = HOME_TEST_DIR
home_dir = path.get_home_dir()
nt.assert_equal(home_dir, env["HOME"])
@with_environment
@skip_win32
def test_get_home_dir_4():
"""Testcase $HOME is not set, os=='posix'.
This should fail with HomeDirError"""
os.name = 'posix'
if 'HOME' in env: del env['HOME']
nt.assert_raises(path.HomeDirError, path.get_home_dir)
@skip_if_not_win32
@with_environment
def test_get_home_dir_5():
"""Using HOMEDRIVE + HOMEPATH, os=='nt'.
HOMESHARE is missing.
"""
os.name = 'nt'
env.pop('HOMESHARE', None)
env['HOMEDRIVE'], env['HOMEPATH'] = os.path.splitdrive(HOME_TEST_DIR)
home_dir = path.get_home_dir()
nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
@skip_if_not_win32
@with_environment
def test_get_home_dir_6():
"""Using USERPROFILE, os=='nt'.
HOMESHARE, HOMEDRIVE, HOMEPATH are missing.
"""
os.name = 'nt'
env.pop('HOMESHARE', None)
env.pop('HOMEDRIVE', None)
env.pop('HOMEPATH', None)
env["USERPROFILE"] = abspath(HOME_TEST_DIR)
home_dir = path.get_home_dir()
nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
@skip_if_not_win32
@with_environment
def test_get_home_dir_7():
"""Using HOMESHARE, os=='nt'."""
os.name = 'nt'
env["HOMESHARE"] = abspath(HOME_TEST_DIR)
home_dir = path.get_home_dir()
nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
# Should we stub wreg fully so we can run the test on all platforms?
@skip_if_not_win32
@with_environment
def test_get_home_dir_8():
"""Using registry hack for 'My Documents', os=='nt'
HOMESHARE, HOMEDRIVE, HOMEPATH, USERPROFILE and others are missing.
"""
os.name = 'nt'
# Remove from stub environment all keys that may be set
for key in ['HOME', 'HOMESHARE', 'HOMEDRIVE', 'HOMEPATH', 'USERPROFILE']:
env.pop(key, None)
#Stub windows registry functions
def OpenKey(x, y):
class key:
def Close(self):
pass
return key()
def QueryValueEx(x, y):
return [abspath(HOME_TEST_DIR)]
wreg.OpenKey = OpenKey
wreg.QueryValueEx = QueryValueEx
home_dir = path.get_home_dir()
nt.assert_equal(home_dir, abspath(HOME_TEST_DIR))
@with_environment
def test_get_ipython_dir_1():
"""test_get_ipython_dir_1, Testcase to see if we can call get_ipython_dir without Exceptions."""
env_ipdir = os.path.join("someplace", ".ipython")
path._writable_dir = lambda path: True
env['IPYTHON_DIR'] = env_ipdir
ipdir = path.get_ipython_dir()
nt.assert_equal(ipdir, env_ipdir)
@with_environment
def test_get_ipython_dir_2():
"""test_get_ipython_dir_2, Testcase to see if we can call get_ipython_dir without Exceptions."""
path.get_home_dir = lambda : "someplace"
path.get_xdg_dir = lambda : None
path._writable_dir = lambda path: True
os.name = "posix"
env.pop('IPYTHON_DIR', None)
env.pop('IPYTHONDIR', None)
env.pop('XDG_CONFIG_HOME', None)
ipdir = path.get_ipython_dir()
nt.assert_equal(ipdir, os.path.join("someplace", ".ipython"))
@with_environment
def test_get_ipython_dir_3():
"""test_get_ipython_dir_3, use XDG if defined, and .ipython doesn't exist."""
path.get_home_dir = lambda : "someplace"
path._writable_dir = lambda path: True
os.name = "posix"
env.pop('IPYTHON_DIR', None)
env.pop('IPYTHONDIR', None)
env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
ipdir = path.get_ipython_dir()
nt.assert_equal(ipdir, os.path.join(XDG_TEST_DIR, "ipython"))
@with_environment
def test_get_ipython_dir_4():
"""test_get_ipython_dir_4, use XDG if both exist."""
path.get_home_dir = lambda : HOME_TEST_DIR
os.name = "posix"
env.pop('IPYTHON_DIR', None)
env.pop('IPYTHONDIR', None)
env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
xdg_ipdir = os.path.join(XDG_TEST_DIR, "ipython")
ipdir = path.get_ipython_dir()
nt.assert_equal(ipdir, xdg_ipdir)
@with_environment
def test_get_ipython_dir_5():
"""test_get_ipython_dir_5, use .ipython if exists and XDG defined, but doesn't exist."""
path.get_home_dir = lambda : HOME_TEST_DIR
os.name = "posix"
env.pop('IPYTHON_DIR', None)
env.pop('IPYTHONDIR', None)
env['XDG_CONFIG_HOME'] = XDG_TEST_DIR
os.rmdir(os.path.join(XDG_TEST_DIR, 'ipython'))
ipdir = path.get_ipython_dir()
nt.assert_equal(ipdir, IP_TEST_DIR)
@with_environment
def test_get_ipython_dir_6():
"""test_get_ipython_dir_6, use XDG if defined and neither exist."""
xdg = os.path.join(HOME_TEST_DIR, 'somexdg')
os.mkdir(xdg)
shutil.rmtree(os.path.join(HOME_TEST_DIR, '.ipython'))
path.get_home_dir = lambda : HOME_TEST_DIR
path.get_xdg_dir = lambda : xdg
os.name = "posix"
env.pop('IPYTHON_DIR', None)
env.pop('IPYTHONDIR', None)
env.pop('XDG_CONFIG_HOME', None)
xdg_ipdir = os.path.join(xdg, "ipython")
ipdir = path.get_ipython_dir()
nt.assert_equal(ipdir, xdg_ipdir)
@with_environment
def test_get_ipython_dir_7():
"""test_get_ipython_dir_7, test home directory expansion on IPYTHON_DIR"""
path._writable_dir = lambda path: True
home_dir = os.path.expanduser('~')
env['IPYTHON_DIR'] = os.path.join('~', 'somewhere')
ipdir = path.get_ipython_dir()
nt.assert_equal(ipdir, os.path.join(home_dir, 'somewhere'))
@with_environment
def test_get_xdg_dir_1():
"""test_get_xdg_dir_1, check xdg_dir"""
reload(path)
path._writable_dir = lambda path: True
path.get_home_dir = lambda : 'somewhere'
os.name = "posix"
env.pop('IPYTHON_DIR', None)
env.pop('IPYTHONDIR', None)
env.pop('XDG_CONFIG_HOME', None)
nt.assert_equal(path.get_xdg_dir(), os.path.join('somewhere', '.config'))
@with_environment
def test_get_xdg_dir_1():
"""test_get_xdg_dir_1, check nonexistant xdg_dir"""
reload(path)
path.get_home_dir = lambda : HOME_TEST_DIR
os.name = "posix"
env.pop('IPYTHON_DIR', None)
env.pop('IPYTHONDIR', None)
env.pop('XDG_CONFIG_HOME', None)
nt.assert_equal(path.get_xdg_dir(), None)
@with_environment
def test_get_xdg_dir_2():
"""test_get_xdg_dir_2, check xdg_dir default to ~/.config"""
reload(path)
path.get_home_dir = lambda : HOME_TEST_DIR
os.name = "posix"
env.pop('IPYTHON_DIR', None)
env.pop('IPYTHONDIR', None)
env.pop('XDG_CONFIG_HOME', None)
cfgdir=os.path.join(path.get_home_dir(), '.config')
os.makedirs(cfgdir)
nt.assert_equal(path.get_xdg_dir(), cfgdir)
def test_filefind():
"""Various tests for filefind"""
f = tempfile.NamedTemporaryFile()
# print 'fname:',f.name
alt_dirs = path.get_ipython_dir()
t = path.filefind(f.name, alt_dirs)
# print 'found:',t
def test_get_ipython_package_dir():
ipdir = path.get_ipython_package_dir()
nt.assert_true(os.path.isdir(ipdir))
def test_get_ipython_module_path():
ipapp_path = path.get_ipython_module_path('IPython.frontend.terminal.ipapp')
nt.assert_true(os.path.isfile(ipapp_path))
@dec.skip_if_not_win32
def test_get_long_path_name_win32():
p = path.get_long_path_name('c:\\docume~1')
nt.assert_equals(p,u'c:\\Documents and Settings')
@dec.skip_win32
def test_get_long_path_name():
p = path.get_long_path_name('/usr/local')
nt.assert_equals(p,'/usr/local')
@dec.skip_win32 # can't create not-user-writable dir on win
@with_environment
def test_not_writable_ipdir():
tmpdir = tempfile.mkdtemp()
os.name = "posix"
env.pop('IPYTHON_DIR', None)
env.pop('IPYTHONDIR', None)
env.pop('XDG_CONFIG_HOME', None)
env['HOME'] = tmpdir
ipdir = os.path.join(tmpdir, '.ipython')
os.mkdir(ipdir)
os.chmod(ipdir, 600)
stderr = io.stderr
pipe = StringIO.StringIO()
io.stderr = pipe
ipdir = path.get_ipython_dir()
io.stderr.flush()
io.stderr = stderr
nt.assert_true('WARNING' in pipe.getvalue())
env.pop('IPYTHON_DIR', None)
def test_unquote_filename():
for win32 in (True, False):
nt.assert_equals(path.unquote_filename('foo.py', win32=win32), 'foo.py')
nt.assert_equals(path.unquote_filename('foo bar.py', win32=win32), 'foo bar.py')
nt.assert_equals(path.unquote_filename('"foo.py"', win32=True), 'foo.py')
nt.assert_equals(path.unquote_filename('"foo bar.py"', win32=True), 'foo bar.py')
nt.assert_equals(path.unquote_filename("'foo.py'", win32=True), 'foo.py')
nt.assert_equals(path.unquote_filename("'foo bar.py'", win32=True), 'foo bar.py')
nt.assert_equals(path.unquote_filename('"foo.py"', win32=False), '"foo.py"')
nt.assert_equals(path.unquote_filename('"foo bar.py"', win32=False), '"foo bar.py"')
nt.assert_equals(path.unquote_filename("'foo.py'", win32=False), "'foo.py'")
nt.assert_equals(path.unquote_filename("'foo bar.py'", win32=False), "'foo bar.py'")
@with_environment
def test_get_py_filename():
os.chdir(TMP_TEST_DIR)
for win32 in (True, False):
with make_tempfile('foo.py'):
nt.assert_equals(path.get_py_filename('foo.py', force_win32=win32), 'foo.py')
nt.assert_equals(path.get_py_filename('foo', force_win32=win32), 'foo.py')
with make_tempfile('foo'):
nt.assert_equals(path.get_py_filename('foo', force_win32=win32), 'foo')
nt.assert_raises(IOError, path.get_py_filename, 'foo.py', force_win32=win32)
nt.assert_raises(IOError, path.get_py_filename, 'foo', force_win32=win32)
nt.assert_raises(IOError, path.get_py_filename, 'foo.py', force_win32=win32)
true_fn = 'foo with spaces.py'
with make_tempfile(true_fn):
nt.assert_equals(path.get_py_filename('foo with spaces', force_win32=win32), true_fn)
nt.assert_equals(path.get_py_filename('foo with spaces.py', force_win32=win32), true_fn)
if win32:
nt.assert_equals(path.get_py_filename('"foo with spaces.py"', force_win32=True), true_fn)
nt.assert_equals(path.get_py_filename("'foo with spaces.py'", force_win32=True), true_fn)
else:
nt.assert_raises(IOError, path.get_py_filename, '"foo with spaces.py"', force_win32=False)
nt.assert_raises(IOError, path.get_py_filename, "'foo with spaces.py'", force_win32=False)