1
# Copyright (C) 2007-2011, 2016 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
from bzrlib.tests.features import backslashdir_feature
33
from bzrlib.win32utils import glob_expand, get_app_path
34
from bzrlib.tests import (
39
Win32RegistryFeature = features.ModuleAvailableFeature('_winreg')
40
CtypesFeature = features.ModuleAvailableFeature('ctypes')
41
Win32comShellFeature = features.ModuleAvailableFeature('win32com.shell')
42
Win32ApiFeature = features.ModuleAvailableFeature('win32api')
48
class TestWin32UtilsGlobExpand(TestCaseInTempDir):
50
_test_needs_features = []
52
def test_empty_tree(self):
58
[['a', 'a'], ['a', 'a']]])
60
def build_ascii_tree(self):
61
self.build_tree(['a', 'a1', 'a2', 'a11', 'a.1',
62
'b', 'b1', 'b2', 'b3',
64
'd/', 'd/d1', 'd/d2', 'd/e/', 'd/e/e1'])
66
def build_unicode_tree(self):
67
self.requireFeature(features.UnicodeFilenameFeature)
68
self.build_tree([u'\u1234', u'\u1234\u1234', u'\u1235/',
71
def test_tree_ascii(self):
72
"""Checks the glob expansion and path separation char
74
self.build_ascii_tree()
78
[[u'a', u'a' ], [u'a', u'a']],
84
[[u'a*'], [u'a', u'a1', u'a2', u'a11', u'a.1']],
85
[[u'?'], [u'a', u'b', u'c', u'd']],
86
[[u'a?'], [u'a1', u'a2']],
87
[[u'a??'], [u'a11', u'a.1']],
88
[[u'b[1-2]'], [u'b1', u'b2']],
90
[[u'd/*'], [u'd/d1', u'd/d2', u'd/e']],
91
[[u'?/*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
92
[[u'*/*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
93
[[u'*/'], [u'c/', u'd/']],
96
def test_backslash_globbing(self):
97
self.requireFeature(backslashdir_feature)
98
self.build_ascii_tree()
101
[[u'd\\*'], [u'd/d1', u'd/d2', u'd/e']],
102
[[u'?\\*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
103
[[u'*\\*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
104
[[u'*\\'], [u'c/', u'd/']],
107
def test_case_insensitive_globbing(self):
108
if os.path.normcase("AbC") == "AbC":
109
self.skip("Test requires case insensitive globbing function")
110
self.build_ascii_tree()
113
[[u'A?'], [u'a1', u'a2']],
116
def test_tree_unicode(self):
117
"""Checks behaviour with non-ascii filenames"""
118
self.build_unicode_tree()
121
[[u'\u1234'], [u'\u1234']],
122
[[u'\u1235'], [u'\u1235']],
124
[[u'\u1235/'], [u'\u1235/']],
125
[[u'\u1235/\u1235'], [u'\u1235/\u1235']],
128
[[u'?'], [u'\u1234', u'\u1235']],
129
[[u'*'], [u'\u1234', u'\u1234\u1234', u'\u1235']],
130
[[u'\u1234*'], [u'\u1234', u'\u1234\u1234']],
132
[[u'\u1235/?'], [u'\u1235/\u1235']],
133
[[u'\u1235/*'], [u'\u1235/\u1235']],
134
[[u'?/'], [u'\u1235/']],
135
[[u'*/'], [u'\u1235/']],
136
[[u'?/?'], [u'\u1235/\u1235']],
137
[[u'*/*'], [u'\u1235/\u1235']],
140
def test_unicode_backslashes(self):
141
self.requireFeature(backslashdir_feature)
142
self.build_unicode_tree()
145
[[u'\u1235\\'], [u'\u1235/']],
146
[[u'\u1235\\\u1235'], [u'\u1235/\u1235']],
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 _run_testset(self, testset):
156
for pattern, expected in testset:
157
result = glob_expand(pattern)
160
self.assertEqual(expected, result, 'pattern %s' % pattern)
163
class TestAppPaths(TestCase):
165
_test_needs_features = [Win32RegistryFeature]
167
def test_iexplore(self):
168
# typical windows users should have IE installed
169
for a in ('iexplore', 'iexplore.exe'):
171
d, b = os.path.split(p)
172
self.assertEqual('iexplore.exe', b.lower())
173
self.assertNotEqual('', d)
175
def test_wordpad(self):
176
# typical windows users should have wordpad in the system
177
# but there is problem: its path has the format REG_EXPAND_SZ
178
# so naive attempt to get the path is not working
179
self.requireFeature(Win32ApiFeature)
180
for a in ('wordpad', 'wordpad.exe'):
182
d, b = os.path.split(p)
183
self.assertEqual('wordpad.exe', b.lower())
184
self.assertNotEqual('', d)
186
def test_not_existing(self):
187
p = get_app_path('not-existing')
188
self.assertEqual('not-existing', p)
191
class TestLocations(TestCase):
192
"""Tests for windows specific path and name retrieving functions"""
194
def test__ensure_unicode_deprecated(self):
196
u1 = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
197
win32utils._ensure_unicode, s)
198
self.assertEqual(s, u1)
199
self.assertIsInstance(u1, unicode)
200
u2 = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
201
win32utils._ensure_unicode, u1)
202
self.assertIs(u1, u2)
204
def test_appdata_unicode_deprecated(self):
205
self.overrideEnv("APPDATA", "fakepath")
206
s = win32utils.get_appdata_location()
207
u = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
208
win32utils.get_appdata_location_unicode)
209
self.assertEqual(s, u)
210
self.assertIsInstance(s, unicode)
212
def test_home_unicode_deprecated(self):
213
s = win32utils.get_home_location()
214
u = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
215
win32utils.get_home_location_unicode)
216
self.assertEqual(s, u)
217
self.assertIsInstance(s, unicode)
219
def test_user_unicode_deprecated(self):
220
self.overrideEnv("USERNAME", "alien")
221
s = win32utils.get_user_name()
222
u = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
223
win32utils.get_user_name_unicode)
224
self.assertEqual(s, u)
225
self.assertIsInstance(s, unicode)
227
def test_host_unicode_deprecated(self):
228
self.overrideEnv("COMPUTERNAME", "alienbox")
229
s = win32utils.get_host_name()
230
u = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
231
win32utils.get_host_name_unicode)
232
self.assertEqual(s, u)
233
self.assertIsInstance(s, unicode)
236
class TestLocationsCtypes(TestCase):
238
_test_needs_features = [CtypesFeature]
240
def assertPathsEqual(self, p1, p2):
241
# TODO: The env var values in particular might return the "short"
242
# version (ie, "C:\DOCUME~1\..."). Its even possible the returned
243
# values will differ only by case - handle these situations as we
245
self.assertEqual(p1, p2)
247
def test_appdata_not_using_environment(self):
248
# Test that we aren't falling back to the environment
249
first = win32utils.get_appdata_location()
250
self.overrideEnv("APPDATA", None)
251
self.assertPathsEqual(first, win32utils.get_appdata_location())
253
def test_appdata_matches_environment(self):
254
# Typically the APPDATA environment variable will match
255
# get_appdata_location
256
# XXX - See bug 262874, which asserts the correct encoding is 'mbcs',
257
encoding = osutils.get_user_encoding()
258
env_val = os.environ.get("APPDATA", None)
260
raise TestSkipped("No APPDATA environment variable exists")
261
self.assertPathsEqual(win32utils.get_appdata_location(),
262
env_val.decode(encoding))
264
def test_local_appdata_not_using_environment(self):
265
# Test that we aren't falling back to the environment
266
first = win32utils.get_local_appdata_location()
267
self.overrideEnv("LOCALAPPDATA", None)
268
self.assertPathsEqual(first, win32utils.get_local_appdata_location())
270
def test_local_appdata_matches_environment(self):
271
# LOCALAPPDATA typically only exists on Vista, so we only attempt to
272
# compare when it exists.
273
lad = win32utils.get_local_appdata_location()
274
env = os.environ.get("LOCALAPPDATA")
276
# XXX - See bug 262874, which asserts the correct encoding is 'mbcs'
277
encoding = osutils.get_user_encoding()
278
self.assertPathsEqual(lad, env.decode(encoding))
281
class TestLocationsPywin32(TestLocationsCtypes):
283
_test_needs_features = [Win32comShellFeature]
286
super(TestLocationsPywin32, self).setUp()
287
# We perform the exact same tests after disabling the use of ctypes.
288
# This causes the implementation to fall back to pywin32.
289
self.overrideAttr(win32utils, 'has_ctypes', False)
290
# FIXME: this should be done by parametrization -- vila 100123
293
class TestSetHidden(TestCaseInTempDir):
295
def test_unicode_dir(self):
296
# we should handle unicode paths without errors
297
self.requireFeature(features.UnicodeFilenameFeature)
299
win32utils.set_file_attr_hidden(u'\u1234')
301
def test_dot_bzr_in_unicode_dir(self):
302
# we should not raise traceback if we try to set hidden attribute
303
# on .bzr directory below unicode path
304
self.requireFeature(features.UnicodeFilenameFeature)
305
os.makedirs(u'\u1234\\.bzr')
306
path = osutils.abspath(u'\u1234\\.bzr')
307
win32utils.set_file_attr_hidden(path)
310
class Test_CommandLineToArgv(tests.TestCaseInTempDir):
312
def assertCommandLine(self, expected, line, argv=None,
313
single_quotes_allowed=False):
314
# Strictly speaking we should respect parameter order versus glob
315
# expansions, but it's not really worth the effort here
318
argv = win32utils._command_line_to_argv(line, argv,
319
single_quotes_allowed=single_quotes_allowed)
320
self.assertEqual(expected, sorted(argv))
322
def test_glob_paths(self):
323
self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
324
self.assertCommandLine([u'a/b.c', u'a/c.c'], 'a/*.c')
325
self.build_tree(['b/', 'b/b.c', 'b/d.c', 'b/d.h'])
326
self.assertCommandLine([u'a/b.c', u'b/b.c'], '*/b.c')
327
self.assertCommandLine([u'a/b.c', u'a/c.c', u'b/b.c', u'b/d.c'],
329
# Bash style, just pass through the argument if nothing matches
330
self.assertCommandLine([u'*/*.qqq'], '*/*.qqq')
332
def test_quoted_globs(self):
333
self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
334
self.assertCommandLine([u'a/*.c'], '"a/*.c"')
335
self.assertCommandLine([u"'a/*.c'"], "'a/*.c'")
336
self.assertCommandLine([u'a/*.c'], "'a/*.c'",
337
single_quotes_allowed=True)
339
def test_slashes_changed(self):
340
# Quoting doesn't change the supplied args
341
self.assertCommandLine([u'a\\*.c'], '"a\\*.c"')
342
self.assertCommandLine([u'a\\*.c'], "'a\\*.c'",
343
single_quotes_allowed=True)
344
# Expands the glob, but nothing matches, swaps slashes
345
self.assertCommandLine([u'a/*.c'], 'a\\*.c')
346
self.assertCommandLine([u'a/?.c'], 'a\\?.c')
347
# No glob, doesn't touch slashes
348
self.assertCommandLine([u'a\\foo.c'], 'a\\foo.c')
350
def test_single_quote_support(self):
351
self.assertCommandLine(["add", "let's-do-it.txt"],
352
"add let's-do-it.txt",
353
["add", "let's-do-it.txt"])
354
self.expectFailure("Using single quotes breaks trimming from argv",
355
self.assertCommandLine, ["add", "lets do it.txt"],
356
"add 'lets do it.txt'", ["add", "'lets", "do", "it.txt'"],
357
single_quotes_allowed=True)
359
def test_case_insensitive_globs(self):
360
if os.path.normcase("AbC") == "AbC":
361
self.skip("Test requires case insensitive globbing function")
362
self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
363
self.assertCommandLine([u'A/b.c'], 'A/B*')
365
def test_backslashes(self):
366
self.requireFeature(backslashdir_feature)
367
self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
368
self.assertCommandLine([u'a/b.c'], 'a\\b*')
370
def test_with_pdb(self):
371
"""Check stripping Python arguments before bzr script per lp:587868"""
372
self.assertCommandLine([u"rocks"], "-m pdb rocks", ["rocks"])
373
self.build_tree(['d/', 'd/f1', 'd/f2'])
374
self.assertCommandLine([u"rm", u"x*"], "-m pdb rm x*", ["rm", u"x*"])
375
self.assertCommandLine([u"add", u"d/f1", u"d/f2"], "-m pdb add d/*",
379
class TestGetEnvironUnicode(tests.TestCase):
380
"""Tests for accessing the environment via the windows wide api"""
382
_test_needs_features = [CtypesFeature, features.win32_feature]
385
super(TestGetEnvironUnicode, self).setUp()
386
self.overrideEnv("TEST", "1")
389
"""In the normal case behaves the same as os.environ access"""
390
self.assertEqual("1", win32utils.get_environ_unicode("TEST"))
392
def test_unset(self):
393
"""A variable not present in the environment gives None by default"""
394
del os.environ["TEST"]
395
self.assertIs(None, win32utils.get_environ_unicode("TEST"))
397
def test_unset_default(self):
398
"""A variable not present in the environment gives passed default"""
399
del os.environ["TEST"]
400
self.assertIs("a", win32utils.get_environ_unicode("TEST", "a"))
402
def test_unicode(self):
403
"""A non-ascii variable is returned as unicode"""
404
unicode_val = u"\xa7" # non-ascii character present in many encodings
406
bytes_val = unicode_val.encode(osutils.get_user_encoding())
407
except UnicodeEncodeError:
408
self.skip("Couldn't encode non-ascii string to place in environ")
409
os.environ["TEST"] = bytes_val
410
self.assertEqual(unicode_val, win32utils.get_environ_unicode("TEST"))
413
"""A variable bigger than heuristic buffer size is still accessible"""
414
big_val = "x" * (2<<10)
415
os.environ["TEST"] = big_val
416
self.assertEqual(big_val, win32utils.get_environ_unicode("TEST"))
418
def test_unexpected_error(self):
419
"""An error from the underlying platform function is propogated"""
420
ERROR_INVALID_PARAMETER = 87
421
SetLastError = win32utils.ctypes.windll.kernel32.SetLastError
422
def failer(*args, **kwargs):
423
SetLastError(ERROR_INVALID_PARAMETER)
425
self.overrideAttr(win32utils.get_environ_unicode, "_c_function",
427
e = self.assertRaises(WindowsError,
428
win32utils.get_environ_unicode, "TEST")
429
self.assertEqual(e.winerror, ERROR_INVALID_PARAMETER)
added
removed
bzrlib/tests/test_win32utils.py
