1
# Copyright (C) 2007-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for win32utils."""
27
from bzrlib.tests import (
32
UnicodeFilenameFeature,
34
from bzrlib.tests.features import backslashdir_feature
35
from bzrlib.win32utils import glob_expand, get_app_path
38
class _RequiredModuleFeature(Feature):
40
def __init__(self, mod_name):
41
self.mod_name = mod_name
42
super(_RequiredModuleFeature, self).__init__()
46
__import__(self.mod_name)
51
def feature_name(self):
54
Win32RegistryFeature = _RequiredModuleFeature('_winreg')
55
CtypesFeature = _RequiredModuleFeature('ctypes')
56
Win32comShellFeature = _RequiredModuleFeature('win32com.shell')
57
Win32ApiFeature = _RequiredModuleFeature('win32api')
63
class TestWin32UtilsGlobExpand(TestCaseInTempDir):
65
_test_needs_features = []
67
def test_empty_tree(self):
73
[['a', 'a'], ['a', 'a']]])
75
def build_ascii_tree(self):
76
self.build_tree(['a', 'a1', 'a2', 'a11', 'a.1',
77
'b', 'b1', 'b2', 'b3',
79
'd/', 'd/d1', 'd/d2', 'd/e/', 'd/e/e1'])
81
def build_unicode_tree(self):
82
self.requireFeature(UnicodeFilenameFeature)
83
self.build_tree([u'\u1234', u'\u1234\u1234', u'\u1235/',
86
def test_tree_ascii(self):
87
"""Checks the glob expansion and path separation char
89
self.build_ascii_tree()
93
[[u'a', u'a' ], [u'a', u'a']],
99
[[u'a*'], [u'a', u'a1', u'a2', u'a11', u'a.1']],
100
[[u'?'], [u'a', u'b', u'c', u'd']],
101
[[u'a?'], [u'a1', u'a2']],
102
[[u'a??'], [u'a11', u'a.1']],
103
[[u'b[1-2]'], [u'b1', u'b2']],
105
[[u'd/*'], [u'd/d1', u'd/d2', u'd/e']],
106
[[u'?/*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
107
[[u'*/*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
108
[[u'*/'], [u'c/', u'd/']],
111
def test_backslash_globbing(self):
112
self.requireFeature(backslashdir_feature)
113
self.build_ascii_tree()
116
[[u'd\\*'], [u'd/d1', u'd/d2', u'd/e']],
117
[[u'?\\*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
118
[[u'*\\*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
119
[[u'*\\'], [u'c/', u'd/']],
122
def test_case_insensitive_globbing(self):
123
if os.path.normcase("AbC") == "AbC":
124
self.skip("Test requires case insensitive globbing function")
125
self.build_ascii_tree()
128
[[u'A?'], [u'a1', u'a2']],
131
def test_tree_unicode(self):
132
"""Checks behaviour with non-ascii filenames"""
133
self.build_unicode_tree()
136
[[u'\u1234'], [u'\u1234']],
137
[[u'\u1235'], [u'\u1235']],
139
[[u'\u1235/'], [u'\u1235/']],
140
[[u'\u1235/\u1235'], [u'\u1235/\u1235']],
143
[[u'?'], [u'\u1234', u'\u1235']],
144
[[u'*'], [u'\u1234', u'\u1234\u1234', u'\u1235']],
145
[[u'\u1234*'], [u'\u1234', u'\u1234\u1234']],
147
[[u'\u1235/?'], [u'\u1235/\u1235']],
148
[[u'\u1235/*'], [u'\u1235/\u1235']],
149
[[u'?/'], [u'\u1235/']],
150
[[u'*/'], [u'\u1235/']],
151
[[u'?/?'], [u'\u1235/\u1235']],
152
[[u'*/*'], [u'\u1235/\u1235']],
155
def test_unicode_backslashes(self):
156
self.requireFeature(backslashdir_feature)
157
self.build_unicode_tree()
160
[[u'\u1235\\'], [u'\u1235/']],
161
[[u'\u1235\\\u1235'], [u'\u1235/\u1235']],
162
[[u'\u1235\\?'], [u'\u1235/\u1235']],
163
[[u'\u1235\\*'], [u'\u1235/\u1235']],
164
[[u'?\\'], [u'\u1235/']],
165
[[u'*\\'], [u'\u1235/']],
166
[[u'?\\?'], [u'\u1235/\u1235']],
167
[[u'*\\*'], [u'\u1235/\u1235']],
170
def _run_testset(self, testset):
171
for pattern, expected in testset:
172
result = glob_expand(pattern)
175
self.assertEqual(expected, result, 'pattern %s' % pattern)
178
class TestAppPaths(TestCase):
180
_test_needs_features = [Win32RegistryFeature]
182
def test_iexplore(self):
183
# typical windows users should have IE installed
184
for a in ('iexplore', 'iexplore.exe'):
186
d, b = os.path.split(p)
187
self.assertEquals('iexplore.exe', b.lower())
188
self.assertNotEquals('', d)
190
def test_wordpad(self):
191
# typical windows users should have wordpad in the system
192
# but there is problem: its path has the format REG_EXPAND_SZ
193
# so naive attempt to get the path is not working
194
self.requireFeature(Win32ApiFeature)
195
for a in ('wordpad', 'wordpad.exe'):
197
d, b = os.path.split(p)
198
self.assertEquals('wordpad.exe', b.lower())
199
self.assertNotEquals('', d)
201
def test_not_existing(self):
202
p = get_app_path('not-existing')
203
self.assertEquals('not-existing', p)
206
class TestLocationsCtypes(TestCase):
208
_test_needs_features = [CtypesFeature]
210
def assertPathsEqual(self, p1, p2):
211
# TODO: The env var values in particular might return the "short"
212
# version (ie, "C:\DOCUME~1\..."). Its even possible the returned
213
# values will differ only by case - handle these situations as we
215
self.assertEquals(p1, p2)
217
def test_appdata_not_using_environment(self):
218
# Test that we aren't falling back to the environment
219
first = win32utils.get_appdata_location()
220
self._captureVar("APPDATA", None)
221
self.assertPathsEqual(first, win32utils.get_appdata_location())
223
def test_appdata_matches_environment(self):
224
# Typically the APPDATA environment variable will match
225
# get_appdata_location
226
# XXX - See bug 262874, which asserts the correct encoding is 'mbcs',
227
encoding = osutils.get_user_encoding()
228
env_val = os.environ.get("APPDATA", None)
230
raise TestSkipped("No APPDATA environment variable exists")
231
self.assertPathsEqual(win32utils.get_appdata_location(),
232
env_val.decode(encoding))
234
def test_local_appdata_not_using_environment(self):
235
# Test that we aren't falling back to the environment
236
first = win32utils.get_local_appdata_location()
237
self._captureVar("LOCALAPPDATA", None)
238
self.assertPathsEqual(first, win32utils.get_local_appdata_location())
240
def test_local_appdata_matches_environment(self):
241
# LOCALAPPDATA typically only exists on Vista, so we only attempt to
242
# compare when it exists.
243
lad = win32utils.get_local_appdata_location()
244
env = os.environ.get("LOCALAPPDATA")
246
# XXX - See bug 262874, which asserts the correct encoding is 'mbcs'
247
encoding = osutils.get_user_encoding()
248
self.assertPathsEqual(lad, env.decode(encoding))
251
class TestLocationsPywin32(TestLocationsCtypes):
253
_test_needs_features = [Win32comShellFeature]
256
super(TestLocationsPywin32, self).setUp()
257
# We perform the exact same tests after disabling the use of ctypes.
258
# This causes the implementation to fall back to pywin32.
259
self.overrideAttr(win32utils, 'has_ctypes', False)
260
# FIXME: this should be done by parametrization -- vila 100123
263
class TestSetHidden(TestCaseInTempDir):
265
def test_unicode_dir(self):
266
# we should handle unicode paths without errors
267
self.requireFeature(UnicodeFilenameFeature)
269
win32utils.set_file_attr_hidden(u'\u1234')
271
def test_dot_bzr_in_unicode_dir(self):
272
# we should not raise traceback if we try to set hidden attribute
273
# on .bzr directory below unicode path
274
self.requireFeature(UnicodeFilenameFeature)
275
os.makedirs(u'\u1234\\.bzr')
276
path = osutils.abspath(u'\u1234\\.bzr')
277
win32utils.set_file_attr_hidden(path)
280
class Test_CommandLineToArgv(tests.TestCaseInTempDir):
282
def assertCommandLine(self, expected, line, argv=None,
283
single_quotes_allowed=False):
284
# Strictly speaking we should respect parameter order versus glob
285
# expansions, but it's not really worth the effort here
288
argv = win32utils._command_line_to_argv(line, argv,
289
single_quotes_allowed=single_quotes_allowed)
290
self.assertEqual(expected, sorted(argv))
292
def test_glob_paths(self):
293
self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
294
self.assertCommandLine([u'a/b.c', u'a/c.c'], 'a/*.c')
295
self.build_tree(['b/', 'b/b.c', 'b/d.c', 'b/d.h'])
296
self.assertCommandLine([u'a/b.c', u'b/b.c'], '*/b.c')
297
self.assertCommandLine([u'a/b.c', u'a/c.c', u'b/b.c', u'b/d.c'],
299
# Bash style, just pass through the argument if nothing matches
300
self.assertCommandLine([u'*/*.qqq'], '*/*.qqq')
302
def test_quoted_globs(self):
303
self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
304
self.assertCommandLine([u'a/*.c'], '"a/*.c"')
305
self.assertCommandLine([u"'a/*.c'"], "'a/*.c'")
306
self.assertCommandLine([u'a/*.c'], "'a/*.c'",
307
single_quotes_allowed=True)
309
def test_slashes_changed(self):
310
# Quoting doesn't change the supplied args
311
self.assertCommandLine([u'a\\*.c'], '"a\\*.c"')
312
self.assertCommandLine([u'a\\*.c'], "'a\\*.c'",
313
single_quotes_allowed=True)
314
# Expands the glob, but nothing matches, swaps slashes
315
self.assertCommandLine([u'a/*.c'], 'a\\*.c')
316
self.assertCommandLine([u'a/?.c'], 'a\\?.c')
317
# No glob, doesn't touch slashes
318
self.assertCommandLine([u'a\\foo.c'], 'a\\foo.c')
320
def test_single_quote_support(self):
321
self.assertCommandLine(["add", "let's-do-it.txt"],
322
"add let's-do-it.txt",
323
["add", "let's-do-it.txt"])
324
self.expectFailure("Using single quotes breaks trimming from argv",
325
self.assertCommandLine, ["add", "lets do it.txt"],
326
"add 'lets do it.txt'", ["add", "'lets", "do", "it.txt'"],
327
single_quotes_allowed=True)
329
def test_case_insensitive_globs(self):
330
if os.path.normcase("AbC") == "AbC":
331
self.skip("Test requires case insensitive globbing function")
332
self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
333
self.assertCommandLine([u'A/b.c'], 'A/B*')
335
def test_backslashes(self):
336
self.requireFeature(backslashdir_feature)
337
self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
338
self.assertCommandLine([u'a/b.c'], 'a\\b*')
340
def test_with_pdb(self):
341
"""Check stripping Python arguments before bzr script per lp:587868"""
342
self.assertCommandLine([u"rocks"], "-m pdb rocks", ["rocks"])
343
self.build_tree(['d/', 'd/f1', 'd/f2'])
344
self.assertCommandLine([u"rm", u"x*"], "-m pdb rm x*", ["rm", u"x*"])
345
self.assertCommandLine([u"add", u"d/f1", u"d/f2"], "-m pdb add d/*",