/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 breezy/tests/test_win32utils.py

  • Committer: Jelmer Vernooij
  • Date: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_win32utils.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007-2011, 2016 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
 
from bzrlib import (
 
21
from .. import (
21
22
    osutils,
22
23
    tests,
23
24
    win32utils,
24
25
    )
25
 
from bzrlib.tests import (
26
 
    Feature,
 
26
from . import (
27
27
    TestCase,
28
28
    TestCaseInTempDir,
29
29
    TestSkipped,
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
 
# -----
 
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
 
74
40
 
75
41
class TestWin32UtilsGlobExpand(TestCaseInTempDir):
76
42
 
91
57
                         'd/', 'd/d1', 'd/d2', 'd/e/', 'd/e/e1'])
92
58
 
93
59
    def build_unicode_tree(self):
94
 
        self.requireFeature(UnicodeFilenameFeature)
 
60
        self.requireFeature(features.UnicodeFilenameFeature)
95
61
        self.build_tree([u'\u1234', u'\u1234\u1234', u'\u1235/',
96
62
                         u'\u1235/\u1235'])
97
63
 
102
68
        self._run_testset([
103
69
            # no wildcards
104
70
            [[u'a'], [u'a']],
105
 
            [[u'a', u'a' ], [u'a', u'a']],
 
71
            [[u'a', u'a'], [u'a', u'a']],
106
72
 
107
73
            [[u'd'], [u'd']],
108
74
            [[u'd/'], [u'd/']],
121
87
            ])
122
88
 
123
89
    def test_backslash_globbing(self):
124
 
        self.requireFeature(BackslashDirSeparatorFeature)
 
90
        self.requireFeature(backslashdir_feature)
125
91
        self.build_ascii_tree()
126
92
        self._run_testset([
127
93
            [[u'd\\'], [u'd/']],
132
98
            ])
133
99
 
134
100
    def test_case_insensitive_globbing(self):
135
 
        self.requireFeature(tests.CaseInsCasePresFilenameFeature)
 
101
        if os.path.normcase("AbC") == "AbC":
 
102
            self.skipTest("Test requires case insensitive globbing function")
136
103
        self.build_ascii_tree()
137
104
        self._run_testset([
138
105
            [[u'A'], [u'A']],
164
131
            ])
165
132
 
166
133
    def test_unicode_backslashes(self):
167
 
        self.requireFeature(BackslashDirSeparatorFeature)
 
134
        self.requireFeature(backslashdir_feature)
168
135
        self.build_unicode_tree()
169
136
        self._run_testset([
170
137
            # no wildcards
195
162
        for a in ('iexplore', 'iexplore.exe'):
196
163
            p = get_app_path(a)
197
164
            d, b = os.path.split(p)
198
 
            self.assertEquals('iexplore.exe', b.lower())
199
 
            self.assertNotEquals('', d)
 
165
            self.assertEqual('iexplore.exe', b.lower())
 
166
            self.assertNotEqual('', d)
200
167
 
201
168
    def test_wordpad(self):
202
169
        # typical windows users should have wordpad in the system
203
170
        # but there is problem: its path has the format REG_EXPAND_SZ
204
171
        # so naive attempt to get the path is not working
 
172
        self.requireFeature(Win32ApiFeature)
205
173
        for a in ('wordpad', 'wordpad.exe'):
206
174
            p = get_app_path(a)
207
175
            d, b = os.path.split(p)
208
 
            self.assertEquals('wordpad.exe', b.lower())
209
 
            self.assertNotEquals('', d)
 
176
            self.assertEqual('wordpad.exe', b.lower())
 
177
            self.assertNotEqual('', d)
210
178
 
211
179
    def test_not_existing(self):
212
180
        p = get_app_path('not-existing')
213
 
        self.assertEquals('not-existing', p)
214
 
 
215
 
 
216
 
class TestLocationsCtypes(TestCase):
217
 
 
218
 
    _test_needs_features = [CtypesFeature]
 
181
        self.assertEqual('not-existing', p)
 
182
 
 
183
 
 
184
class TestLocations(TestCase):
 
185
 
 
186
    _test_needs_features = [features.win32_feature]
219
187
 
220
188
    def assertPathsEqual(self, p1, p2):
221
189
        # TODO: The env var values in particular might return the "short"
222
190
        # version (ie, "C:\DOCUME~1\...").  Its even possible the returned
223
191
        # values will differ only by case - handle these situations as we
224
192
        # come across them.
225
 
        self.assertEquals(p1, p2)
 
193
        self.assertEqual(p1, p2)
226
194
 
227
195
    def test_appdata_not_using_environment(self):
228
196
        # Test that we aren't falling back to the environment
229
197
        first = win32utils.get_appdata_location()
230
 
        self._captureVar("APPDATA", None)
 
198
        self.overrideEnv("APPDATA", None)
231
199
        self.assertPathsEqual(first, win32utils.get_appdata_location())
232
200
 
233
201
    def test_appdata_matches_environment(self):
244
212
    def test_local_appdata_not_using_environment(self):
245
213
        # Test that we aren't falling back to the environment
246
214
        first = win32utils.get_local_appdata_location()
247
 
        self._captureVar("LOCALAPPDATA", None)
 
215
        self.overrideEnv("LOCALAPPDATA", None)
248
216
        self.assertPathsEqual(first, win32utils.get_local_appdata_location())
249
217
 
250
218
    def test_local_appdata_matches_environment(self):
253
221
        lad = win32utils.get_local_appdata_location()
254
222
        env = os.environ.get("LOCALAPPDATA")
255
223
        if env:
256
 
            # XXX - See bug 262874, which asserts the correct encoding is 'mbcs'
 
224
            # XXX - See bug 262874, which asserts the correct encoding is
 
225
            # 'mbcs'
257
226
            encoding = osutils.get_user_encoding()
258
227
            self.assertPathsEqual(lad, env.decode(encoding))
259
228
 
260
229
 
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
 
 
273
230
class TestSetHidden(TestCaseInTempDir):
274
231
 
 
232
    _test_needs_features = [features.win32_feature]
 
233
 
275
234
    def test_unicode_dir(self):
276
235
        # we should handle unicode paths without errors
277
 
        self.requireFeature(UnicodeFilenameFeature)
 
236
        self.requireFeature(features.UnicodeFilenameFeature)
278
237
        os.mkdir(u'\u1234')
279
238
        win32utils.set_file_attr_hidden(u'\u1234')
280
239
 
281
240
    def test_dot_bzr_in_unicode_dir(self):
282
241
        # we should not raise traceback if we try to set hidden attribute
283
242
        # on .bzr directory below unicode path
284
 
        self.requireFeature(UnicodeFilenameFeature)
 
243
        self.requireFeature(features.UnicodeFilenameFeature)
285
244
        os.makedirs(u'\u1234\\.bzr')
286
245
        path = osutils.abspath(u'\u1234\\.bzr')
287
246
        win32utils.set_file_attr_hidden(path)
288
247
 
289
248
 
290
 
 
291
 
 
292
249
class Test_CommandLineToArgv(tests.TestCaseInTempDir):
293
250
 
294
 
    def assertCommandLine(self, expected, line, single_quotes_allowed=False):
 
251
    def assertCommandLine(self, expected, line, argv=None,
 
252
                          single_quotes_allowed=False):
295
253
        # Strictly speaking we should respect parameter order versus glob
296
254
        # expansions, but it's not really worth the effort here
297
 
        argv = win32utils._command_line_to_argv(line,
298
 
                single_quotes_allowed=single_quotes_allowed)
 
255
        if argv is None:
 
256
            argv = [line]
 
257
        argv = win32utils._command_line_to_argv(
 
258
            line, argv, single_quotes_allowed=single_quotes_allowed)
299
259
        self.assertEqual(expected, sorted(argv))
300
260
 
301
261
    def test_glob_paths(self):
313
273
        self.assertCommandLine([u'a/*.c'], '"a/*.c"')
314
274
        self.assertCommandLine([u"'a/*.c'"], "'a/*.c'")
315
275
        self.assertCommandLine([u'a/*.c'], "'a/*.c'",
316
 
            single_quotes_allowed=True)
 
276
                               single_quotes_allowed=True)
317
277
 
318
278
    def test_slashes_changed(self):
319
279
        # Quoting doesn't change the supplied args
320
280
        self.assertCommandLine([u'a\\*.c'], '"a\\*.c"')
321
281
        self.assertCommandLine([u'a\\*.c'], "'a\\*.c'",
322
 
            single_quotes_allowed=True)
 
282
                               single_quotes_allowed=True)
323
283
        # Expands the glob, but nothing matches, swaps slashes
324
284
        self.assertCommandLine([u'a/*.c'], 'a\\*.c')
325
285
        self.assertCommandLine([u'a/?.c'], 'a\\?.c')
328
288
 
329
289
    def test_single_quote_support(self):
330
290
        self.assertCommandLine(["add", "let's-do-it.txt"],
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)
 
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)
334
298
 
335
299
    def test_case_insensitive_globs(self):
336
 
        self.requireFeature(tests.CaseInsCasePresFilenameFeature)
 
300
        if os.path.normcase("AbC") == "AbC":
 
301
            self.skipTest("Test requires case insensitive globbing function")
337
302
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
338
303
        self.assertCommandLine([u'A/b.c'], 'A/B*')
339
304
 
340
305
    def test_backslashes(self):
341
 
        self.requireFeature(BackslashDirSeparatorFeature)
 
306
        self.requireFeature(backslashdir_feature)
342
307
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
343
308
        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)