/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_win32utils.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_win32utils.py
1
 
# Copyright (C) 2007-2011, 2016 Canonical Ltd
 
1
# Copyright (C) 2007-2010 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
 
 
19
17
import os
 
18
import sys
20
19
 
21
 
from .. import (
 
20
from bzrlib import (
22
21
    osutils,
23
22
    tests,
24
23
    win32utils,
25
24
    )
26
 
from . import (
 
25
from bzrlib.tests import (
 
26
    Feature,
27
27
    TestCase,
28
28
    TestCaseInTempDir,
29
29
    TestSkipped,
30
 
    )
31
 
from .features import backslashdir_feature
32
 
from ..win32utils import glob_expand, get_app_path
33
 
from . import (
34
 
    features,
35
 
    )
36
 
 
37
 
 
38
 
Win32RegistryFeature = features.ModuleAvailableFeature('_winreg')
39
 
 
 
30
    UnicodeFilenameFeature,
 
31
    )
 
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')
 
70
 
 
71
 
 
72
# Tests
 
73
# -----
40
74
 
41
75
class TestWin32UtilsGlobExpand(TestCaseInTempDir):
42
76
 
57
91
                         'd/', 'd/d1', 'd/d2', 'd/e/', 'd/e/e1'])
58
92
 
59
93
    def build_unicode_tree(self):
60
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
94
        self.requireFeature(UnicodeFilenameFeature)
61
95
        self.build_tree([u'\u1234', u'\u1234\u1234', u'\u1235/',
62
96
                         u'\u1235/\u1235'])
63
97
 
68
102
        self._run_testset([
69
103
            # no wildcards
70
104
            [[u'a'], [u'a']],
71
 
            [[u'a', u'a'], [u'a', u'a']],
 
105
            [[u'a', u'a' ], [u'a', u'a']],
72
106
 
73
107
            [[u'd'], [u'd']],
74
108
            [[u'd/'], [u'd/']],
87
121
            ])
88
122
 
89
123
    def test_backslash_globbing(self):
90
 
        self.requireFeature(backslashdir_feature)
 
124
        self.requireFeature(BackslashDirSeparatorFeature)
91
125
        self.build_ascii_tree()
92
126
        self._run_testset([
93
127
            [[u'd\\'], [u'd/']],
98
132
            ])
99
133
 
100
134
    def test_case_insensitive_globbing(self):
101
 
        if os.path.normcase("AbC") == "AbC":
102
 
            self.skipTest("Test requires case insensitive globbing function")
 
135
        self.requireFeature(tests.CaseInsCasePresFilenameFeature)
103
136
        self.build_ascii_tree()
104
137
        self._run_testset([
105
138
            [[u'A'], [u'A']],
131
164
            ])
132
165
 
133
166
    def test_unicode_backslashes(self):
134
 
        self.requireFeature(backslashdir_feature)
 
167
        self.requireFeature(BackslashDirSeparatorFeature)
135
168
        self.build_unicode_tree()
136
169
        self._run_testset([
137
170
            # no wildcards
162
195
        for a in ('iexplore', 'iexplore.exe'):
163
196
            p = get_app_path(a)
164
197
            d, b = os.path.split(p)
165
 
            self.assertEqual('iexplore.exe', b.lower())
166
 
            self.assertNotEqual('', d)
 
198
            self.assertEquals('iexplore.exe', b.lower())
 
199
            self.assertNotEquals('', d)
167
200
 
168
201
    def test_wordpad(self):
169
202
        # typical windows users should have wordpad in the system
170
203
        # but there is problem: its path has the format REG_EXPAND_SZ
171
204
        # so naive attempt to get the path is not working
172
 
        self.requireFeature(Win32ApiFeature)
173
205
        for a in ('wordpad', 'wordpad.exe'):
174
206
            p = get_app_path(a)
175
207
            d, b = os.path.split(p)
176
 
            self.assertEqual('wordpad.exe', b.lower())
177
 
            self.assertNotEqual('', d)
 
208
            self.assertEquals('wordpad.exe', b.lower())
 
209
            self.assertNotEquals('', d)
178
210
 
179
211
    def test_not_existing(self):
180
212
        p = get_app_path('not-existing')
181
 
        self.assertEqual('not-existing', p)
182
 
 
183
 
 
184
 
class TestLocations(TestCase):
185
 
 
186
 
    _test_needs_features = [features.win32_feature]
 
213
        self.assertEquals('not-existing', p)
 
214
 
 
215
 
 
216
class TestLocationsCtypes(TestCase):
 
217
 
 
218
    _test_needs_features = [CtypesFeature]
187
219
 
188
220
    def assertPathsEqual(self, p1, p2):
189
221
        # TODO: The env var values in particular might return the "short"
190
222
        # version (ie, "C:\DOCUME~1\...").  Its even possible the returned
191
223
        # values will differ only by case - handle these situations as we
192
224
        # come across them.
193
 
        self.assertEqual(p1, p2)
 
225
        self.assertEquals(p1, p2)
194
226
 
195
227
    def test_appdata_not_using_environment(self):
196
228
        # Test that we aren't falling back to the environment
197
229
        first = win32utils.get_appdata_location()
198
 
        self.overrideEnv("APPDATA", None)
 
230
        self._captureVar("APPDATA", None)
199
231
        self.assertPathsEqual(first, win32utils.get_appdata_location())
200
232
 
201
233
    def test_appdata_matches_environment(self):
212
244
    def test_local_appdata_not_using_environment(self):
213
245
        # Test that we aren't falling back to the environment
214
246
        first = win32utils.get_local_appdata_location()
215
 
        self.overrideEnv("LOCALAPPDATA", None)
 
247
        self._captureVar("LOCALAPPDATA", None)
216
248
        self.assertPathsEqual(first, win32utils.get_local_appdata_location())
217
249
 
218
250
    def test_local_appdata_matches_environment(self):
221
253
        lad = win32utils.get_local_appdata_location()
222
254
        env = os.environ.get("LOCALAPPDATA")
223
255
        if env:
224
 
            # XXX - See bug 262874, which asserts the correct encoding is
225
 
            # 'mbcs'
 
256
            # XXX - See bug 262874, which asserts the correct encoding is 'mbcs'
226
257
            encoding = osutils.get_user_encoding()
227
258
            self.assertPathsEqual(lad, env.decode(encoding))
228
259
 
229
260
 
 
261
class TestLocationsPywin32(TestLocationsCtypes):
 
262
 
 
263
    _test_needs_features = [Win32comShellFeature]
 
264
 
 
265
    def setUp(self):
 
266
        super(TestLocationsPywin32, self).setUp()
 
267
        # We perform the exact same tests after disabling the use of ctypes.
 
268
        # This causes the implementation to fall back to pywin32.
 
269
        self.overrideAttr(win32utils, 'has_ctypes', False)
 
270
        # FIXME: this should be done by parametrization -- vila 100123
 
271
 
 
272
 
230
273
class TestSetHidden(TestCaseInTempDir):
231
274
 
232
 
    _test_needs_features = [features.win32_feature]
233
 
 
234
275
    def test_unicode_dir(self):
235
276
        # we should handle unicode paths without errors
236
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
277
        self.requireFeature(UnicodeFilenameFeature)
237
278
        os.mkdir(u'\u1234')
238
279
        win32utils.set_file_attr_hidden(u'\u1234')
239
280
 
240
281
    def test_dot_bzr_in_unicode_dir(self):
241
282
        # we should not raise traceback if we try to set hidden attribute
242
283
        # on .bzr directory below unicode path
243
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
284
        self.requireFeature(UnicodeFilenameFeature)
244
285
        os.makedirs(u'\u1234\\.bzr')
245
286
        path = osutils.abspath(u'\u1234\\.bzr')
246
287
        win32utils.set_file_attr_hidden(path)
247
288
 
248
289
 
 
290
 
 
291
 
249
292
class Test_CommandLineToArgv(tests.TestCaseInTempDir):
250
293
 
251
 
    def assertCommandLine(self, expected, line, argv=None,
252
 
                          single_quotes_allowed=False):
 
294
    def assertCommandLine(self, expected, line, single_quotes_allowed=False):
253
295
        # Strictly speaking we should respect parameter order versus glob
254
296
        # expansions, but it's not really worth the effort here
255
 
        if argv is None:
256
 
            argv = [line]
257
 
        argv = win32utils._command_line_to_argv(
258
 
            line, argv, single_quotes_allowed=single_quotes_allowed)
 
297
        argv = win32utils._command_line_to_argv(line,
 
298
                single_quotes_allowed=single_quotes_allowed)
259
299
        self.assertEqual(expected, sorted(argv))
260
300
 
261
301
    def test_glob_paths(self):
273
313
        self.assertCommandLine([u'a/*.c'], '"a/*.c"')
274
314
        self.assertCommandLine([u"'a/*.c'"], "'a/*.c'")
275
315
        self.assertCommandLine([u'a/*.c'], "'a/*.c'",
276
 
                               single_quotes_allowed=True)
 
316
            single_quotes_allowed=True)
277
317
 
278
318
    def test_slashes_changed(self):
279
319
        # Quoting doesn't change the supplied args
280
320
        self.assertCommandLine([u'a\\*.c'], '"a\\*.c"')
281
321
        self.assertCommandLine([u'a\\*.c'], "'a\\*.c'",
282
 
                               single_quotes_allowed=True)
 
322
            single_quotes_allowed=True)
283
323
        # Expands the glob, but nothing matches, swaps slashes
284
324
        self.assertCommandLine([u'a/*.c'], 'a\\*.c')
285
325
        self.assertCommandLine([u'a/?.c'], 'a\\?.c')
288
328
 
289
329
    def test_single_quote_support(self):
290
330
        self.assertCommandLine(["add", "let's-do-it.txt"],
291
 
                               "add let's-do-it.txt",
292
 
                               ["add", "let's-do-it.txt"])
293
 
        self.expectFailure("Using single quotes breaks trimming from argv",
294
 
                           self.assertCommandLine, ["add", "lets do it.txt"],
295
 
                           "add 'lets do it.txt'", [
296
 
                               "add", "'lets", "do", "it.txt'"],
297
 
                           single_quotes_allowed=True)
 
331
            "add let's-do-it.txt")
 
332
        self.assertCommandLine(["add", "lets do it.txt"],
 
333
            "add 'lets do it.txt'", single_quotes_allowed=True)
298
334
 
299
335
    def test_case_insensitive_globs(self):
300
 
        if os.path.normcase("AbC") == "AbC":
301
 
            self.skipTest("Test requires case insensitive globbing function")
 
336
        self.requireFeature(tests.CaseInsCasePresFilenameFeature)
302
337
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
303
338
        self.assertCommandLine([u'A/b.c'], 'A/B*')
304
339
 
305
340
    def test_backslashes(self):
306
 
        self.requireFeature(backslashdir_feature)
 
341
        self.requireFeature(BackslashDirSeparatorFeature)
307
342
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
308
343
        self.assertCommandLine([u'a/b.c'], 'a\\b*')
309
 
 
310
 
    def test_with_pdb(self):
311
 
        """Check stripping Python arguments before bzr script per lp:587868"""
312
 
        self.assertCommandLine([u"rocks"], "-m pdb rocks", ["rocks"])
313
 
        self.build_tree(['d/', 'd/f1', 'd/f2'])
314
 
        self.assertCommandLine([u"rm", u"x*"], "-m pdb rm x*", ["rm", u"x*"])
315
 
        self.assertCommandLine([u"add", u"d/f1", u"d/f2"], "-m pdb add d/*",
316
 
                               ["add", u"d/*"])
317
 
 
318
 
 
319
 
class TestGetEnvironUnicode(tests.TestCase):
320
 
    """Tests for accessing the environment via the windows wide api"""
321
 
 
322
 
    _test_needs_features = [features.win32_feature]
323
 
 
324
 
    def setUp(self):
325
 
        super(TestGetEnvironUnicode, self).setUp()
326
 
        self.overrideEnv("TEST", "1")
327
 
 
328
 
    def test_get(self):
329
 
        """In the normal case behaves the same as os.environ access"""
330
 
        self.assertEqual("1", win32utils.get_environ_unicode("TEST"))
331
 
 
332
 
    def test_unset(self):
333
 
        """A variable not present in the environment gives None by default"""
334
 
        del os.environ["TEST"]
335
 
        self.assertIs(None, win32utils.get_environ_unicode("TEST"))
336
 
 
337
 
    def test_unset_default(self):
338
 
        """A variable not present in the environment gives passed default"""
339
 
        del os.environ["TEST"]
340
 
        self.assertIs("a", win32utils.get_environ_unicode("TEST", "a"))
341
 
 
342
 
    def test_unicode(self):
343
 
        """A non-ascii variable is returned as unicode"""
344
 
        unicode_val = u"\xa7"  # non-ascii character present in many encodings
345
 
        try:
346
 
            bytes_val = unicode_val.encode(osutils.get_user_encoding())
347
 
        except UnicodeEncodeError:
348
 
            self.skipTest("Couldn't encode non-ascii string for environ")
349
 
        os.environ["TEST"] = bytes_val
350
 
        self.assertEqual(unicode_val, win32utils.get_environ_unicode("TEST"))
351
 
 
352
 
    def test_long(self):
353
 
        """A variable bigger than heuristic buffer size is still accessible"""
354
 
        big_val = "x" * (2 << 10)
355
 
        os.environ["TEST"] = big_val
356
 
        self.assertEqual(big_val, win32utils.get_environ_unicode("TEST"))
357
 
 
358
 
    def test_unexpected_error(self):
359
 
        """An error from the underlying platform function is propogated"""
360
 
        ERROR_INVALID_PARAMETER = 87
361
 
        SetLastError = win32utils.ctypes.windll.kernel32.SetLastError
362
 
 
363
 
        def failer(*args, **kwargs):
364
 
            SetLastError(ERROR_INVALID_PARAMETER)
365
 
            return 0
366
 
        self.overrideAttr(win32utils.get_environ_unicode, "_c_function",
367
 
                          failer)
368
 
        e = self.assertRaises(WindowsError,
369
 
                              win32utils.get_environ_unicode, "TEST")
370
 
        self.assertEqual(e.winerror, ERROR_INVALID_PARAMETER)