/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

[merge] robertc's integration, updated tests to check for retcode=3

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_win32utils.py
1
 
# Copyright (C) 2007-2011, 2016 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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
16
 
 
17
 
"""Tests for win32utils."""
18
 
 
19
 
import os
20
 
 
21
 
from .. import (
22
 
    osutils,
23
 
    tests,
24
 
    win32utils,
25
 
    )
26
 
from . import (
27
 
    TestCase,
28
 
    TestCaseInTempDir,
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
 
 
40
 
 
41
 
class TestWin32UtilsGlobExpand(TestCaseInTempDir):
42
 
 
43
 
    _test_needs_features = []
44
 
 
45
 
    def test_empty_tree(self):
46
 
        self.build_tree([])
47
 
        self._run_testset([
48
 
            [['a'], ['a']],
49
 
            [['?'], ['?']],
50
 
            [['*'], ['*']],
51
 
            [['a', 'a'], ['a', 'a']]])
52
 
 
53
 
    def build_ascii_tree(self):
54
 
        self.build_tree(['a', 'a1', 'a2', 'a11', 'a.1',
55
 
                         'b', 'b1', 'b2', 'b3',
56
 
                         'c/', 'c/c1', 'c/c2',
57
 
                         'd/', 'd/d1', 'd/d2', 'd/e/', 'd/e/e1'])
58
 
 
59
 
    def build_unicode_tree(self):
60
 
        self.requireFeature(features.UnicodeFilenameFeature)
61
 
        self.build_tree([u'\u1234', u'\u1234\u1234', u'\u1235/',
62
 
                         u'\u1235/\u1235'])
63
 
 
64
 
    def test_tree_ascii(self):
65
 
        """Checks the glob expansion and path separation char
66
 
        normalization"""
67
 
        self.build_ascii_tree()
68
 
        self._run_testset([
69
 
            # no wildcards
70
 
            [[u'a'], [u'a']],
71
 
            [[u'a', u'a'], [u'a', u'a']],
72
 
 
73
 
            [[u'd'], [u'd']],
74
 
            [[u'd/'], [u'd/']],
75
 
 
76
 
            # wildcards
77
 
            [[u'a*'], [u'a', u'a1', u'a2', u'a11', u'a.1']],
78
 
            [[u'?'], [u'a', u'b', u'c', u'd']],
79
 
            [[u'a?'], [u'a1', u'a2']],
80
 
            [[u'a??'], [u'a11', u'a.1']],
81
 
            [[u'b[1-2]'], [u'b1', u'b2']],
82
 
 
83
 
            [[u'd/*'], [u'd/d1', u'd/d2', u'd/e']],
84
 
            [[u'?/*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
85
 
            [[u'*/*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
86
 
            [[u'*/'], [u'c/', u'd/']],
87
 
            ])
88
 
 
89
 
    def test_backslash_globbing(self):
90
 
        self.requireFeature(backslashdir_feature)
91
 
        self.build_ascii_tree()
92
 
        self._run_testset([
93
 
            [[u'd\\'], [u'd/']],
94
 
            [[u'd\\*'], [u'd/d1', u'd/d2', u'd/e']],
95
 
            [[u'?\\*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
96
 
            [[u'*\\*'], [u'c/c1', u'c/c2', u'd/d1', u'd/d2', u'd/e']],
97
 
            [[u'*\\'], [u'c/', u'd/']],
98
 
            ])
99
 
 
100
 
    def test_case_insensitive_globbing(self):
101
 
        if os.path.normcase("AbC") == "AbC":
102
 
            self.skipTest("Test requires case insensitive globbing function")
103
 
        self.build_ascii_tree()
104
 
        self._run_testset([
105
 
            [[u'A'], [u'A']],
106
 
            [[u'A?'], [u'a1', u'a2']],
107
 
            ])
108
 
 
109
 
    def test_tree_unicode(self):
110
 
        """Checks behaviour with non-ascii filenames"""
111
 
        self.build_unicode_tree()
112
 
        self._run_testset([
113
 
            # no wildcards
114
 
            [[u'\u1234'], [u'\u1234']],
115
 
            [[u'\u1235'], [u'\u1235']],
116
 
 
117
 
            [[u'\u1235/'], [u'\u1235/']],
118
 
            [[u'\u1235/\u1235'], [u'\u1235/\u1235']],
119
 
 
120
 
            # wildcards
121
 
            [[u'?'], [u'\u1234', u'\u1235']],
122
 
            [[u'*'], [u'\u1234', u'\u1234\u1234', u'\u1235']],
123
 
            [[u'\u1234*'], [u'\u1234', u'\u1234\u1234']],
124
 
 
125
 
            [[u'\u1235/?'], [u'\u1235/\u1235']],
126
 
            [[u'\u1235/*'], [u'\u1235/\u1235']],
127
 
            [[u'?/'], [u'\u1235/']],
128
 
            [[u'*/'], [u'\u1235/']],
129
 
            [[u'?/?'], [u'\u1235/\u1235']],
130
 
            [[u'*/*'], [u'\u1235/\u1235']],
131
 
            ])
132
 
 
133
 
    def test_unicode_backslashes(self):
134
 
        self.requireFeature(backslashdir_feature)
135
 
        self.build_unicode_tree()
136
 
        self._run_testset([
137
 
            # no wildcards
138
 
            [[u'\u1235\\'], [u'\u1235/']],
139
 
            [[u'\u1235\\\u1235'], [u'\u1235/\u1235']],
140
 
            [[u'\u1235\\?'], [u'\u1235/\u1235']],
141
 
            [[u'\u1235\\*'], [u'\u1235/\u1235']],
142
 
            [[u'?\\'], [u'\u1235/']],
143
 
            [[u'*\\'], [u'\u1235/']],
144
 
            [[u'?\\?'], [u'\u1235/\u1235']],
145
 
            [[u'*\\*'], [u'\u1235/\u1235']],
146
 
            ])
147
 
 
148
 
    def _run_testset(self, testset):
149
 
        for pattern, expected in testset:
150
 
            result = glob_expand(pattern)
151
 
            expected.sort()
152
 
            result.sort()
153
 
            self.assertEqual(expected, result, 'pattern %s' % pattern)
154
 
 
155
 
 
156
 
class TestAppPaths(TestCase):
157
 
 
158
 
    _test_needs_features = [Win32RegistryFeature]
159
 
 
160
 
    def test_iexplore(self):
161
 
        # typical windows users should have IE installed
162
 
        for a in ('iexplore', 'iexplore.exe'):
163
 
            p = get_app_path(a)
164
 
            d, b = os.path.split(p)
165
 
            self.assertEqual('iexplore.exe', b.lower())
166
 
            self.assertNotEqual('', d)
167
 
 
168
 
    def test_wordpad(self):
169
 
        # typical windows users should have wordpad in the system
170
 
        # but there is problem: its path has the format REG_EXPAND_SZ
171
 
        # so naive attempt to get the path is not working
172
 
        self.requireFeature(Win32ApiFeature)
173
 
        for a in ('wordpad', 'wordpad.exe'):
174
 
            p = get_app_path(a)
175
 
            d, b = os.path.split(p)
176
 
            self.assertEqual('wordpad.exe', b.lower())
177
 
            self.assertNotEqual('', d)
178
 
 
179
 
    def test_not_existing(self):
180
 
        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]
187
 
 
188
 
    def assertPathsEqual(self, p1, p2):
189
 
        # TODO: The env var values in particular might return the "short"
190
 
        # version (ie, "C:\DOCUME~1\...").  Its even possible the returned
191
 
        # values will differ only by case - handle these situations as we
192
 
        # come across them.
193
 
        self.assertEqual(p1, p2)
194
 
 
195
 
    def test_appdata_not_using_environment(self):
196
 
        # Test that we aren't falling back to the environment
197
 
        first = win32utils.get_appdata_location()
198
 
        self.overrideEnv("APPDATA", None)
199
 
        self.assertPathsEqual(first, win32utils.get_appdata_location())
200
 
 
201
 
    def test_appdata_matches_environment(self):
202
 
        # Typically the APPDATA environment variable will match
203
 
        # get_appdata_location
204
 
        # XXX - See bug 262874, which asserts the correct encoding is 'mbcs',
205
 
        encoding = osutils.get_user_encoding()
206
 
        env_val = os.environ.get("APPDATA", None)
207
 
        if not env_val:
208
 
            raise TestSkipped("No APPDATA environment variable exists")
209
 
        self.assertPathsEqual(win32utils.get_appdata_location(),
210
 
                              env_val.decode(encoding))
211
 
 
212
 
    def test_local_appdata_not_using_environment(self):
213
 
        # Test that we aren't falling back to the environment
214
 
        first = win32utils.get_local_appdata_location()
215
 
        self.overrideEnv("LOCALAPPDATA", None)
216
 
        self.assertPathsEqual(first, win32utils.get_local_appdata_location())
217
 
 
218
 
    def test_local_appdata_matches_environment(self):
219
 
        # LOCALAPPDATA typically only exists on Vista, so we only attempt to
220
 
        # compare when it exists.
221
 
        lad = win32utils.get_local_appdata_location()
222
 
        env = os.environ.get("LOCALAPPDATA")
223
 
        if env:
224
 
            # XXX - See bug 262874, which asserts the correct encoding is
225
 
            # 'mbcs'
226
 
            encoding = osutils.get_user_encoding()
227
 
            self.assertPathsEqual(lad, env.decode(encoding))
228
 
 
229
 
 
230
 
class TestSetHidden(TestCaseInTempDir):
231
 
 
232
 
    _test_needs_features = [features.win32_feature]
233
 
 
234
 
    def test_unicode_dir(self):
235
 
        # we should handle unicode paths without errors
236
 
        self.requireFeature(features.UnicodeFilenameFeature)
237
 
        os.mkdir(u'\u1234')
238
 
        win32utils.set_file_attr_hidden(u'\u1234')
239
 
 
240
 
    def test_dot_bzr_in_unicode_dir(self):
241
 
        # we should not raise traceback if we try to set hidden attribute
242
 
        # on .bzr directory below unicode path
243
 
        self.requireFeature(features.UnicodeFilenameFeature)
244
 
        os.makedirs(u'\u1234\\.bzr')
245
 
        path = osutils.abspath(u'\u1234\\.bzr')
246
 
        win32utils.set_file_attr_hidden(path)
247
 
 
248
 
 
249
 
class Test_CommandLineToArgv(tests.TestCaseInTempDir):
250
 
 
251
 
    def assertCommandLine(self, expected, line, argv=None,
252
 
                          single_quotes_allowed=False):
253
 
        # Strictly speaking we should respect parameter order versus glob
254
 
        # 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)
259
 
        self.assertEqual(expected, sorted(argv))
260
 
 
261
 
    def test_glob_paths(self):
262
 
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
263
 
        self.assertCommandLine([u'a/b.c', u'a/c.c'], 'a/*.c')
264
 
        self.build_tree(['b/', 'b/b.c', 'b/d.c', 'b/d.h'])
265
 
        self.assertCommandLine([u'a/b.c', u'b/b.c'], '*/b.c')
266
 
        self.assertCommandLine([u'a/b.c', u'a/c.c', u'b/b.c', u'b/d.c'],
267
 
                               '*/*.c')
268
 
        # Bash style, just pass through the argument if nothing matches
269
 
        self.assertCommandLine([u'*/*.qqq'], '*/*.qqq')
270
 
 
271
 
    def test_quoted_globs(self):
272
 
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
273
 
        self.assertCommandLine([u'a/*.c'], '"a/*.c"')
274
 
        self.assertCommandLine([u"'a/*.c'"], "'a/*.c'")
275
 
        self.assertCommandLine([u'a/*.c'], "'a/*.c'",
276
 
                               single_quotes_allowed=True)
277
 
 
278
 
    def test_slashes_changed(self):
279
 
        # Quoting doesn't change the supplied args
280
 
        self.assertCommandLine([u'a\\*.c'], '"a\\*.c"')
281
 
        self.assertCommandLine([u'a\\*.c'], "'a\\*.c'",
282
 
                               single_quotes_allowed=True)
283
 
        # Expands the glob, but nothing matches, swaps slashes
284
 
        self.assertCommandLine([u'a/*.c'], 'a\\*.c')
285
 
        self.assertCommandLine([u'a/?.c'], 'a\\?.c')
286
 
        # No glob, doesn't touch slashes
287
 
        self.assertCommandLine([u'a\\foo.c'], 'a\\foo.c')
288
 
 
289
 
    def test_single_quote_support(self):
290
 
        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)
298
 
 
299
 
    def test_case_insensitive_globs(self):
300
 
        if os.path.normcase("AbC") == "AbC":
301
 
            self.skipTest("Test requires case insensitive globbing function")
302
 
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
303
 
        self.assertCommandLine([u'A/b.c'], 'A/B*')
304
 
 
305
 
    def test_backslashes(self):
306
 
        self.requireFeature(backslashdir_feature)
307
 
        self.build_tree(['a/', 'a/b.c', 'a/c.c', 'a/c.h'])
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)