← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_win32utils.py

(jelmer) Use the absolute_import feature everywhere in bzrlib,
 and add a source test to make sure it's used everywhere. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_win32utils.py
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
"""Tests for win32utils."""
 
18
 
17
19
import os
18
 
import sys
19
20
 
20
21
from bzrlib import (
21
22
    osutils,
23
24
    win32utils,
24
25
    )
25
26
from bzrlib.tests import (
26
 
    Feature,
27
27
    TestCase,
28
28
    TestCaseInTempDir,
29
29
    TestSkipped,
30
 
    UnicodeFilenameFeature,
31
30
    )
 
31
from bzrlib.tests.features import backslashdir_feature
32
32
from bzrlib.win32utils import glob_expand, get_app_path
33
 
 
34
 
 
35
 
class _BackslashDirSeparatorFeature(tests.Feature):
36
 
 
37
 
    def _probe(self):
38
 
        try:
39
 
            os.lstat(os.getcwd() + '\\')
40
 
        except OSError:
41
 
            return False
42
 
        else:
43
 
            return True
44
 
 
45
 
    def feature_name(self):
46
 
        return "Filesystem treats '\\' as a directory separator."
47
 
 
48
 
BackslashDirSeparatorFeature = _BackslashDirSeparatorFeature()
49
 
 
50
 
 
51
 
class _RequiredModuleFeature(Feature):
52
 
 
53
 
    def __init__(self, mod_name):
54
 
        self.mod_name = mod_name
55
 
        super(_RequiredModuleFeature, self).__init__()
56
 
 
57
 
    def _probe(self):
58
 
        try:
59
 
            __import__(self.mod_name)
60
 
            return True
61
 
        except ImportError:
62
 
            return False
63
 
 
64
 
    def feature_name(self):
65
 
        return self.mod_name
66
 
 
67
 
Win32RegistryFeature = _RequiredModuleFeature('_winreg')
68
 
CtypesFeature = _RequiredModuleFeature('ctypes')
69
 
Win32comShellFeature = _RequiredModuleFeature('win32com.shell')
 
33
from bzrlib.tests import (
 
34
    features,
 
35
    )
 
36
 
 
37
 
 
38
Win32RegistryFeature = features.ModuleAvailableFeature('_winreg')
 
39
CtypesFeature = features.ModuleAvailableFeature('ctypes')
 
40
Win32comShellFeature = features.ModuleAvailableFeature('win32com.shell')
 
41
Win32ApiFeature = features.ModuleAvailableFeature('win32api') 
70
42
 
71
43
 
72
44
# Tests
91
63
                         'd/', 'd/d1', 'd/d2', 'd/e/', 'd/e/e1'])
92
64
 
93
65
    def build_unicode_tree(self):
94
 
        self.requireFeature(UnicodeFilenameFeature)
 
66
        self.requireFeature(features.UnicodeFilenameFeature)
95
67
        self.build_tree([u'\u1234', u'\u1234\u1234', u'\u1235/',
96
68
                         u'\u1235/\u1235'])
97
69
 
121
93
            ])
122
94
 
123
95
    def test_backslash_globbing(self):
124
 
        self.requireFeature(BackslashDirSeparatorFeature)
 
96
        self.requireFeature(backslashdir_feature)
125
97
        self.build_ascii_tree()
126
98
        self._run_testset([
127
99
            [[u'd\\'], [u'd/']],
132
104
            ])
133
105
 
134
106
    def test_case_insensitive_globbing(self):
135
 
        self.requireFeature(tests.CaseInsCasePresFilenameFeature)
 
107
        if os.path.normcase("AbC") == "AbC":
 
108
            self.skip("Test requires case insensitive globbing function")
136
109
        self.build_ascii_tree()
137
110
        self._run_testset([
138
111
            [[u'A'], [u'A']],
164
137
            ])
165
138
 
166
139
    def test_unicode_backslashes(self):
167
 
        self.requireFeature(BackslashDirSeparatorFeature)
 
140
        self.requireFeature(backslashdir_feature)
168
141
        self.build_unicode_tree()
169
142
        self._run_testset([
170
143
            # no wildcards
202
175
        # typical windows users should have wordpad in the system
203
176
        # but there is problem: its path has the format REG_EXPAND_SZ
204
177
        # so naive attempt to get the path is not working
 
178
        self.requireFeature(Win32ApiFeature)
205
179
        for a in ('wordpad', 'wordpad.exe'):
206
180
            p = get_app_path(a)
207
181
            d, b = os.path.split(p)
227
201
    def test_appdata_not_using_environment(self):
228
202
        # Test that we aren't falling back to the environment
229
203
        first = win32utils.get_appdata_location()
230
 
        self._captureVar("APPDATA", None)
 
204
        self.overrideEnv("APPDATA", None)
231
205
        self.assertPathsEqual(first, win32utils.get_appdata_location())
232
206
 
233
207
    def test_appdata_matches_environment(self):
244
218
    def test_local_appdata_not_using_environment(self):
245
219
        # Test that we aren't falling back to the environment
246
220
        first = win32utils.get_local_appdata_location()
247
 
        self._captureVar("LOCALAPPDATA", None)
 
221
        self.overrideEnv("LOCALAPPDATA", None)
248
222
        self.assertPathsEqual(first, win32utils.get_local_appdata_location())
249
223
 
250
224
    def test_local_appdata_matches_environment(self):
266
240
        super(TestLocationsPywin32, self).setUp()
267
241
        # We perform the exact same tests after disabling the use of ctypes.
268
242
        # This causes the implementation to fall back to pywin32.
269
 
        self.old_ctypes = win32utils.has_ctypes
270
 
        win32utils.has_ctypes = False
271
 
        self.addCleanup(self.restoreCtypes)
272
 
 
273
 
    def restoreCtypes(self):
274
 
        win32utils.has_ctypes = self.old_ctypes
 
243
        self.overrideAttr(win32utils, 'has_ctypes', False)
 
244
        # FIXME: this should be done by parametrization -- vila 100123
275
245
 
276
246
 
277
247
class TestSetHidden(TestCaseInTempDir):
278
248
 
279
249
    def test_unicode_dir(self):
280
250
        # we should handle unicode paths without errors
281
 
        self.requireFeature(UnicodeFilenameFeature)
 
251
        self.requireFeature(features.UnicodeFilenameFeature)
282
252
        os.mkdir(u'\u1234')
283
253
        win32utils.set_file_attr_hidden(u'\u1234')
284
254
 
285
255
    def test_dot_bzr_in_unicode_dir(self):
286
256
        # we should not raise traceback if we try to set hidden attribute
287
257
        # on .bzr directory below unicode path
288
 
        self.requireFeature(UnicodeFilenameFeature)
 
258
        self.requireFeature(features.UnicodeFilenameFeature)
289
259
        os.makedirs(u'\u1234\\.bzr')
290
260
        path = osutils.abspath(u'\u1234\\.bzr')
291
261
        win32utils.set_file_attr_hidden(path)
292
262
 
293
263
 
294
 
 
295
 
class TestUnicodeShlex(tests.TestCase):
296
 
 
297
 
    def assertAsTokens(self, expected, line):
298
 
        s = win32utils.UnicodeShlex(line)
299
 
        self.assertEqual(expected, list(s))
300
 
 
301
 
    def test_simple(self):
302
 
        self.assertAsTokens([(False, u'foo'), (False, u'bar'), (False, u'baz')],
303
 
                            u'foo bar baz')
304
 
 
305
 
    def test_ignore_multiple_spaces(self):
306
 
        self.assertAsTokens([(False, u'foo'), (False, u'bar')], u'foo  bar')
307
 
 
308
 
    def test_ignore_leading_space(self):
309
 
        self.assertAsTokens([(False, u'foo'), (False, u'bar')], u'  foo bar')
310
 
 
311
 
    def test_ignore_trailing_space(self):
312
 
        self.assertAsTokens([(False, u'foo'), (False, u'bar')], u'foo bar  ')
313
 
 
314
 
    def test_posix_quotations(self):
315
 
        self.assertAsTokens([(True, u'foo bar')], u'"foo bar"')
316
 
        self.assertAsTokens([(False, u"'fo''o"), (False, u"b''ar'")],
317
 
            u"'fo''o b''ar'")
318
 
        self.assertAsTokens([(True, u'foo bar')], u'"fo""o b""ar"')
319
 
        self.assertAsTokens([(True, u"fo'o"), (True, u"b'ar")],
320
 
            u'"fo"\'o b\'"ar"')
321
 
 
322
 
    def test_nested_quotations(self):
323
 
        self.assertAsTokens([(True, u'foo"" bar')], u"\"foo\\\"\\\" bar\"")
324
 
        self.assertAsTokens([(True, u'foo\'\' bar')], u"\"foo'' bar\"")
325
 
 
326
 
    def test_empty_result(self):
327
 
        self.assertAsTokens([], u'')
328
 
        self.assertAsTokens([], u'    ')
329
 
 
330
 
    def test_quoted_empty(self):
331
 
        self.assertAsTokens([(True, '')], u'""')
332
 
        self.assertAsTokens([(False, u"''")], u"''")
333
 
 
334
 
    def test_unicode_chars(self):
335
 
        self.assertAsTokens([(False, u'f\xb5\xee'), (False, u'\u1234\u3456')],
336
 
                             u'f\xb5\xee \u1234\u3456')
337
 
 
338
 
    def test_newline_in_quoted_section(self):
339
 
        self.assertAsTokens([(True, u'foo\nbar\nbaz\n')], u'"foo\nbar\nbaz\n"')
340
 
 
341
 
    def test_escape_chars(self):
342
 
        self.assertAsTokens([(False, u'foo\\bar')], u'foo\\bar')
343
 
 
344
 
    def test_escape_quote(self):
345
 
        self.assertAsTokens([(True, u'foo"bar')], u'"foo\\"bar"')
346
 
 
347
 
    def test_double_escape(self):
348
 
        self.assertAsTokens([(True, u'foo\\bar')], u'"foo\\\\bar"')
349
 
        self.assertAsTokens([(False, u'foo\\\\bar')], u"foo\\\\bar")
350
 
 
351
 
 
352
264
class Test_CommandLineToArgv(tests.TestCaseInTempDir):
353
265
 
354
 
    def assertCommandLine(self, expected, line):
 
266
    def assertCommandLine(self, expected, line, argv=None,
 
267
            single_quotes_allowed=False):
355
268
        # Strictly speaking we should respect parameter order versus glob
356
269
        # expansions, but it's not really worth the effort here
357
 
        self.assertEqual(expected,
358
 
                         sorted(win32utils._command_line_to_argv(line)))
 
270
        if argv is None:
 
271
            argv = [line]
 
272
        argv = win32utils._command_line_to_argv(line, argv,
 
273
                single_quotes_allowed=single_quotes_allowed)
 
274
        self.assertEqual(expected, sorted(argv))
359
275
 
360
276
    def test_glob_paths(self):
361
277
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
371
287
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
372
288
        self.assertCommandLine([u'a/*.c'], '"a/*.c"')
373
289
        self.assertCommandLine([u"'a/*.c'"], "'a/*.c'")
 
290
        self.assertCommandLine([u'a/*.c'], "'a/*.c'",
 
291
            single_quotes_allowed=True)
374
292
 
375
293
    def test_slashes_changed(self):
376
294
        # Quoting doesn't change the supplied args
377
295
        self.assertCommandLine([u'a\\*.c'], '"a\\*.c"')
 
296
        self.assertCommandLine([u'a\\*.c'], "'a\\*.c'",
 
297
            single_quotes_allowed=True)
378
298
        # Expands the glob, but nothing matches, swaps slashes
379
299
        self.assertCommandLine([u'a/*.c'], 'a\\*.c')
380
300
        self.assertCommandLine([u'a/?.c'], 'a\\?.c')
381
301
        # No glob, doesn't touch slashes
382
302
        self.assertCommandLine([u'a\\foo.c'], 'a\\foo.c')
383
303
 
384
 
    def test_no_single_quote_supported(self):
 
304
    def test_single_quote_support(self):
385
305
        self.assertCommandLine(["add", "let's-do-it.txt"],
386
 
            "add let's-do-it.txt")
 
306
            "add let's-do-it.txt",
 
307
            ["add", "let's-do-it.txt"])
 
308
        self.expectFailure("Using single quotes breaks trimming from argv",
 
309
            self.assertCommandLine, ["add", "lets do it.txt"],
 
310
            "add 'lets do it.txt'", ["add", "'lets", "do", "it.txt'"],
 
311
            single_quotes_allowed=True)
387
312
 
388
313
    def test_case_insensitive_globs(self):
389
 
        self.requireFeature(tests.CaseInsCasePresFilenameFeature)
 
314
        if os.path.normcase("AbC") == "AbC":
 
315
            self.skip("Test requires case insensitive globbing function")
390
316
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
391
317
        self.assertCommandLine([u'A/b.c'], 'A/B*')
392
318
 
393
319
    def test_backslashes(self):
394
 
        self.requireFeature(BackslashDirSeparatorFeature)
 
320
        self.requireFeature(backslashdir_feature)
395
321
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
396
322
        self.assertCommandLine([u'a/b.c'], 'a\\b*')
 
323
 
 
324
    def test_with_pdb(self):
 
325
        """Check stripping Python arguments before bzr script per lp:587868"""
 
326
        self.assertCommandLine([u"rocks"], "-m pdb rocks", ["rocks"])
 
327
        self.build_tree(['d/', 'd/f1', 'd/f2'])
 
328
        self.assertCommandLine([u"rm", u"x*"], "-m pdb rm x*", ["rm", u"x*"])
 
329
        self.assertCommandLine([u"add", u"d/f1", u"d/f2"], "-m pdb add d/*",
 
330
            ["add", u"d/*"])
 
331
 
 
332
 
 
333
class TestGetEnvironUnicode(tests.TestCase):
 
334
    """Tests for accessing the environment via the windows wide api"""
 
335
 
 
336
    _test_needs_features = [CtypesFeature, features.win32_feature]
 
337
 
 
338
    def setUp(self):
 
339
        super(TestGetEnvironUnicode, self).setUp()
 
340
        self.overrideEnv("TEST", "1")
 
341
 
 
342
    def test_get(self):
 
343
        """In the normal case behaves the same as os.environ access"""
 
344
        self.assertEqual("1", win32utils.get_environ_unicode("TEST"))
 
345
 
 
346
    def test_unset(self):
 
347
        """A variable not present in the environment gives None by default"""
 
348
        del os.environ["TEST"]
 
349
        self.assertIs(None, win32utils.get_environ_unicode("TEST"))
 
350
 
 
351
    def test_unset_default(self):
 
352
        """A variable not present in the environment gives passed default"""
 
353
        del os.environ["TEST"]
 
354
        self.assertIs("a", win32utils.get_environ_unicode("TEST", "a"))
 
355
 
 
356
    def test_unicode(self):
 
357
        """A non-ascii variable is returned as unicode"""
 
358
        unicode_val = u"\xa7" # non-ascii character present in many encodings
 
359
        try:
 
360
            bytes_val = unicode_val.encode(osutils.get_user_encoding())
 
361
        except UnicodeEncodeError:
 
362
            self.skip("Couldn't encode non-ascii string to place in environ")
 
363
        os.environ["TEST"] = bytes_val
 
364
        self.assertEqual(unicode_val, win32utils.get_environ_unicode("TEST"))
 
365
 
 
366
    def test_long(self):
 
367
        """A variable bigger than heuristic buffer size is still accessible"""
 
368
        big_val = "x" * (2<<10)
 
369
        os.environ["TEST"] = big_val
 
370
        self.assertEqual(big_val, win32utils.get_environ_unicode("TEST"))
 
371
 
 
372
    def test_unexpected_error(self):
 
373
        """An error from the underlying platform function is propogated"""
 
374
        ERROR_INVALID_PARAMETER = 87
 
375
        SetLastError = win32utils.ctypes.windll.kernel32.SetLastError
 
376
        def failer(*args, **kwargs):
 
377
            SetLastError(ERROR_INVALID_PARAMETER)
 
378
            return 0
 
379
        self.overrideAttr(win32utils.get_environ_unicode, "_c_function",
 
380
            failer)
 
381
        e = self.assertRaises(WindowsError,
 
382
            win32utils.get_environ_unicode, "TEST")
 
383
        self.assertEqual(e.winerror, ERROR_INVALID_PARAMETER)