~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: Martin Packman
  • Date: 2011-12-13 17:10:47 UTC
  • mto: This revision was merged to the branch mainline in revision 6367.
  • Revision ID: martin.packman@canonical.com-20111213171047-esvi1kyfbuehmhrm
Minor tweaks including normalising _fs_enc value

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for the osutils wrapper."""
18
18
 
 
19
from cStringIO import StringIO
19
20
import errno
20
21
import os
 
22
import re
 
23
import select
21
24
import socket
22
 
import stat
23
25
import sys
 
26
import time
24
27
 
25
 
import bzrlib
26
28
from bzrlib import (
27
29
    errors,
 
30
    lazy_regex,
28
31
    osutils,
 
32
    symbol_versioning,
 
33
    tests,
 
34
    trace,
29
35
    win32utils,
30
36
    )
31
 
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
32
37
from bzrlib.tests import (
33
 
        StringIOWrapper,
34
 
        TestCase, 
35
 
        TestCaseInTempDir, 
36
 
        TestSkipped,
37
 
        )
38
 
 
39
 
 
40
 
class TestOSUtils(TestCaseInTempDir):
 
38
    features,
 
39
    file_utils,
 
40
    test__walkdirs_win32,
 
41
    )
 
42
from bzrlib.tests.scenarios import load_tests_apply_scenarios
 
43
 
 
44
 
 
45
class _UTF8DirReaderFeature(features.Feature):
 
46
 
 
47
    def _probe(self):
 
48
        try:
 
49
            from bzrlib import _readdir_pyx
 
50
            self.reader = _readdir_pyx.UTF8DirReader
 
51
            return True
 
52
        except ImportError:
 
53
            return False
 
54
 
 
55
    def feature_name(self):
 
56
        return 'bzrlib._readdir_pyx'
 
57
 
 
58
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
 
59
 
 
60
term_ios_feature = features.ModuleAvailableFeature('termios')
 
61
 
 
62
 
 
63
def _already_unicode(s):
 
64
    return s
 
65
 
 
66
 
 
67
def _utf8_to_unicode(s):
 
68
    return s.decode('UTF-8')
 
69
 
 
70
 
 
71
def dir_reader_scenarios():
 
72
    # For each dir reader we define:
 
73
 
 
74
    # - native_to_unicode: a function converting the native_abspath as returned
 
75
    #   by DirReader.read_dir to its unicode representation
 
76
 
 
77
    # UnicodeDirReader is the fallback, it should be tested on all platforms.
 
78
    scenarios = [('unicode',
 
79
                  dict(_dir_reader_class=osutils.UnicodeDirReader,
 
80
                       _native_to_unicode=_already_unicode))]
 
81
    # Some DirReaders are platform specific and even there they may not be
 
82
    # available.
 
83
    if UTF8DirReaderFeature.available():
 
84
        from bzrlib import _readdir_pyx
 
85
        scenarios.append(('utf8',
 
86
                          dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
 
87
                               _native_to_unicode=_utf8_to_unicode)))
 
88
 
 
89
    if test__walkdirs_win32.win32_readdir_feature.available():
 
90
        try:
 
91
            from bzrlib import _walkdirs_win32
 
92
            scenarios.append(
 
93
                ('win32',
 
94
                 dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
 
95
                      _native_to_unicode=_already_unicode)))
 
96
        except ImportError:
 
97
            pass
 
98
    return scenarios
 
99
 
 
100
 
 
101
load_tests = load_tests_apply_scenarios
 
102
 
 
103
 
 
104
class TestContainsWhitespace(tests.TestCase):
41
105
 
42
106
    def test_contains_whitespace(self):
43
 
        self.failUnless(osutils.contains_whitespace(u' '))
44
 
        self.failUnless(osutils.contains_whitespace(u'hello there'))
45
 
        self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
46
 
        self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
47
 
        self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
48
 
        self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
 
107
        self.assertTrue(osutils.contains_whitespace(u' '))
 
108
        self.assertTrue(osutils.contains_whitespace(u'hello there'))
 
109
        self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
 
110
        self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
 
111
        self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
 
112
        self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
49
113
 
50
114
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
51
115
        # is whitespace, but we do not.
52
 
        self.failIf(osutils.contains_whitespace(u''))
53
 
        self.failIf(osutils.contains_whitespace(u'hellothere'))
54
 
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
 
116
        self.assertFalse(osutils.contains_whitespace(u''))
 
117
        self.assertFalse(osutils.contains_whitespace(u'hellothere'))
 
118
        self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
 
119
 
 
120
 
 
121
class TestRename(tests.TestCaseInTempDir):
 
122
 
 
123
    def create_file(self, filename, content):
 
124
        f = open(filename, 'wb')
 
125
        try:
 
126
            f.write(content)
 
127
        finally:
 
128
            f.close()
 
129
 
 
130
    def _fancy_rename(self, a, b):
 
131
        osutils.fancy_rename(a, b, rename_func=os.rename,
 
132
                             unlink_func=os.unlink)
55
133
 
56
134
    def test_fancy_rename(self):
57
135
        # This should work everywhere
58
 
        def rename(a, b):
59
 
            osutils.fancy_rename(a, b,
60
 
                    rename_func=os.rename,
61
 
                    unlink_func=os.unlink)
62
 
 
63
 
        open('a', 'wb').write('something in a\n')
64
 
        rename('a', 'b')
65
 
        self.failIfExists('a')
66
 
        self.failUnlessExists('b')
 
136
        self.create_file('a', 'something in a\n')
 
137
        self._fancy_rename('a', 'b')
 
138
        self.assertPathDoesNotExist('a')
 
139
        self.assertPathExists('b')
67
140
        self.check_file_contents('b', 'something in a\n')
68
141
 
69
 
        open('a', 'wb').write('new something in a\n')
70
 
        rename('b', 'a')
 
142
        self.create_file('a', 'new something in a\n')
 
143
        self._fancy_rename('b', 'a')
71
144
 
72
145
        self.check_file_contents('a', 'something in a\n')
73
146
 
 
147
    def test_fancy_rename_fails_source_missing(self):
 
148
        # An exception should be raised, and the target should be left in place
 
149
        self.create_file('target', 'data in target\n')
 
150
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
151
                          'missingsource', 'target')
 
152
        self.assertPathExists('target')
 
153
        self.check_file_contents('target', 'data in target\n')
 
154
 
 
155
    def test_fancy_rename_fails_if_source_and_target_missing(self):
 
156
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
157
                          'missingsource', 'missingtarget')
 
158
 
74
159
    def test_rename(self):
75
160
        # Rename should be semi-atomic on all platforms
76
 
        open('a', 'wb').write('something in a\n')
 
161
        self.create_file('a', 'something in a\n')
77
162
        osutils.rename('a', 'b')
78
 
        self.failIfExists('a')
79
 
        self.failUnlessExists('b')
 
163
        self.assertPathDoesNotExist('a')
 
164
        self.assertPathExists('b')
80
165
        self.check_file_contents('b', 'something in a\n')
81
166
 
82
 
        open('a', 'wb').write('new something in a\n')
 
167
        self.create_file('a', 'new something in a\n')
83
168
        osutils.rename('b', 'a')
84
169
 
85
170
        self.check_file_contents('a', 'something in a\n')
86
171
 
87
172
    # TODO: test fancy_rename using a MemoryTransport
88
173
 
 
174
    def test_rename_change_case(self):
 
175
        # on Windows we should be able to change filename case by rename
 
176
        self.build_tree(['a', 'b/'])
 
177
        osutils.rename('a', 'A')
 
178
        osutils.rename('b', 'B')
 
179
        # we can't use failUnlessExists on case-insensitive filesystem
 
180
        # so try to check shape of the tree
 
181
        shape = sorted(os.listdir('.'))
 
182
        self.assertEquals(['A', 'B'], shape)
 
183
 
 
184
 
 
185
class TestRandChars(tests.TestCase):
 
186
 
89
187
    def test_01_rand_chars_empty(self):
90
188
        result = osutils.rand_chars(0)
91
189
        self.assertEqual(result, '')
96
194
        self.assertEqual(type(result), str)
97
195
        self.assertContainsRe(result, r'^[a-z0-9]{100}$')
98
196
 
 
197
 
 
198
class TestIsInside(tests.TestCase):
 
199
 
99
200
    def test_is_inside(self):
100
201
        is_inside = osutils.is_inside
101
202
        self.assertTrue(is_inside('src', 'src/foo.c'))
105
206
        self.assertFalse(is_inside('foo.c', ''))
106
207
        self.assertTrue(is_inside('', 'foo.c'))
107
208
 
 
209
    def test_is_inside_any(self):
 
210
        SRC_FOO_C = osutils.pathjoin('src', 'foo.c')
 
211
        for dirs, fn in [(['src', 'doc'], SRC_FOO_C),
 
212
                         (['src'], SRC_FOO_C),
 
213
                         (['src'], 'src'),
 
214
                         ]:
 
215
            self.assert_(osutils.is_inside_any(dirs, fn))
 
216
        for dirs, fn in [(['src'], 'srccontrol'),
 
217
                         (['src'], 'srccontrol/foo')]:
 
218
            self.assertFalse(osutils.is_inside_any(dirs, fn))
 
219
 
 
220
    def test_is_inside_or_parent_of_any(self):
 
221
        for dirs, fn in [(['src', 'doc'], 'src/foo.c'),
 
222
                         (['src'], 'src/foo.c'),
 
223
                         (['src/bar.c'], 'src'),
 
224
                         (['src/bar.c', 'bla/foo.c'], 'src'),
 
225
                         (['src'], 'src'),
 
226
                         ]:
 
227
            self.assert_(osutils.is_inside_or_parent_of_any(dirs, fn))
 
228
 
 
229
        for dirs, fn in [(['src'], 'srccontrol'),
 
230
                         (['srccontrol/foo.c'], 'src'),
 
231
                         (['src'], 'srccontrol/foo')]:
 
232
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
 
233
 
 
234
 
 
235
class TestLstat(tests.TestCaseInTempDir):
 
236
 
 
237
    def test_lstat_matches_fstat(self):
 
238
        # On Windows, lstat and fstat don't always agree, primarily in the
 
239
        # 'st_ino' and 'st_dev' fields. So we force them to be '0' in our
 
240
        # custom implementation.
 
241
        if sys.platform == 'win32':
 
242
            # We only have special lstat/fstat if we have the extension.
 
243
            # Without it, we may end up re-reading content when we don't have
 
244
            # to, but otherwise it doesn't effect correctness.
 
245
            self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
246
        f = open('test-file.txt', 'wb')
 
247
        self.addCleanup(f.close)
 
248
        f.write('some content\n')
 
249
        f.flush()
 
250
        self.assertEqualStat(osutils.fstat(f.fileno()),
 
251
                             osutils.lstat('test-file.txt'))
 
252
 
 
253
 
 
254
class TestRmTree(tests.TestCaseInTempDir):
 
255
 
108
256
    def test_rmtree(self):
109
257
        # Check to remove tree with read-only files/dirs
110
258
        os.mkdir('dir')
120
268
 
121
269
        osutils.rmtree('dir')
122
270
 
123
 
        self.failIfExists('dir/file')
124
 
        self.failIfExists('dir')
 
271
        self.assertPathDoesNotExist('dir/file')
 
272
        self.assertPathDoesNotExist('dir')
 
273
 
 
274
 
 
275
class TestDeleteAny(tests.TestCaseInTempDir):
 
276
 
 
277
    def test_delete_any_readonly(self):
 
278
        # from <https://bugs.launchpad.net/bzr/+bug/218206>
 
279
        self.build_tree(['d/', 'f'])
 
280
        osutils.make_readonly('d')
 
281
        osutils.make_readonly('f')
 
282
 
 
283
        osutils.delete_any('f')
 
284
        osutils.delete_any('d')
 
285
 
 
286
 
 
287
class TestKind(tests.TestCaseInTempDir):
125
288
 
126
289
    def test_file_kind(self):
127
290
        self.build_tree(['file', 'dir/'])
130
293
        if osutils.has_symlinks():
131
294
            os.symlink('symlink', 'symlink')
132
295
            self.assertEquals('symlink', osutils.file_kind('symlink'))
133
 
        
 
296
 
134
297
        # TODO: jam 20060529 Test a block device
135
298
        try:
136
299
            os.lstat('/dev/null')
157
320
            finally:
158
321
                os.remove('socket')
159
322
 
 
323
    def test_kind_marker(self):
 
324
        self.assertEqual("", osutils.kind_marker("file"))
 
325
        self.assertEqual("/", osutils.kind_marker('directory'))
 
326
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
 
327
        self.assertEqual("@", osutils.kind_marker("symlink"))
 
328
        self.assertEqual("+", osutils.kind_marker("tree-reference"))
 
329
        self.assertEqual("", osutils.kind_marker("fifo"))
 
330
        self.assertEqual("", osutils.kind_marker("socket"))
 
331
        self.assertEqual("", osutils.kind_marker("unknown"))
 
332
 
 
333
 
 
334
class TestUmask(tests.TestCaseInTempDir):
 
335
 
160
336
    def test_get_umask(self):
161
337
        if sys.platform == 'win32':
162
338
            # umask always returns '0', no way to set it
164
340
            return
165
341
 
166
342
        orig_umask = osutils.get_umask()
167
 
        try:
168
 
            os.umask(0222)
169
 
            self.assertEqual(0222, osutils.get_umask())
170
 
            os.umask(0022)
171
 
            self.assertEqual(0022, osutils.get_umask())
172
 
            os.umask(0002)
173
 
            self.assertEqual(0002, osutils.get_umask())
174
 
            os.umask(0027)
175
 
            self.assertEqual(0027, osutils.get_umask())
176
 
        finally:
177
 
            os.umask(orig_umask)
 
343
        self.addCleanup(os.umask, orig_umask)
 
344
        os.umask(0222)
 
345
        self.assertEqual(0222, osutils.get_umask())
 
346
        os.umask(0022)
 
347
        self.assertEqual(0022, osutils.get_umask())
 
348
        os.umask(0002)
 
349
        self.assertEqual(0002, osutils.get_umask())
 
350
        os.umask(0027)
 
351
        self.assertEqual(0027, osutils.get_umask())
 
352
 
 
353
 
 
354
class TestDateTime(tests.TestCase):
178
355
 
179
356
    def assertFormatedDelta(self, expected, seconds):
180
357
        """Assert osutils.format_delta formats as expected"""
212
389
        self.assertFormatedDelta('1 second in the future', -1)
213
390
        self.assertFormatedDelta('2 seconds in the future', -2)
214
391
 
 
392
    def test_format_date(self):
 
393
        self.assertRaises(errors.UnsupportedTimezoneFormat,
 
394
            osutils.format_date, 0, timezone='foo')
 
395
        self.assertIsInstance(osutils.format_date(0), str)
 
396
        self.assertIsInstance(osutils.format_local_date(0), unicode)
 
397
        # Testing for the actual value of the local weekday without
 
398
        # duplicating the code from format_date is difficult.
 
399
        # Instead blackbox.test_locale should check for localized
 
400
        # dates once they do occur in output strings.
 
401
 
 
402
    def test_format_date_with_offset_in_original_timezone(self):
 
403
        self.assertEqual("Thu 1970-01-01 00:00:00 +0000",
 
404
            osutils.format_date_with_offset_in_original_timezone(0))
 
405
        self.assertEqual("Fri 1970-01-02 03:46:40 +0000",
 
406
            osutils.format_date_with_offset_in_original_timezone(100000))
 
407
        self.assertEqual("Fri 1970-01-02 05:46:40 +0200",
 
408
            osutils.format_date_with_offset_in_original_timezone(100000, 7200))
 
409
 
 
410
    def test_local_time_offset(self):
 
411
        """Test that local_time_offset() returns a sane value."""
 
412
        offset = osutils.local_time_offset()
 
413
        self.assertTrue(isinstance(offset, int))
 
414
        # Test that the offset is no more than a eighteen hours in
 
415
        # either direction.
 
416
        # Time zone handling is system specific, so it is difficult to
 
417
        # do more specific tests, but a value outside of this range is
 
418
        # probably wrong.
 
419
        eighteen_hours = 18 * 3600
 
420
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
421
 
 
422
    def test_local_time_offset_with_timestamp(self):
 
423
        """Test that local_time_offset() works with a timestamp."""
 
424
        offset = osutils.local_time_offset(1000000000.1234567)
 
425
        self.assertTrue(isinstance(offset, int))
 
426
        eighteen_hours = 18 * 3600
 
427
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
428
 
 
429
 
 
430
class TestLinks(tests.TestCaseInTempDir):
 
431
 
215
432
    def test_dereference_path(self):
216
 
        if not osutils.has_symlinks():
217
 
            raise TestSkipped('Symlinks are not supported on this platform')
 
433
        self.requireFeature(features.SymlinkFeature)
218
434
        cwd = osutils.realpath('.')
219
435
        os.mkdir('bar')
220
436
        bar_path = osutils.pathjoin(cwd, 'bar')
223
439
        self.assertEqual(bar_path, osutils.realpath('./bar'))
224
440
        os.symlink('bar', 'foo')
225
441
        self.assertEqual(bar_path, osutils.realpath('./foo'))
226
 
        
 
442
 
227
443
        # Does not dereference terminal symlinks
228
444
        foo_path = osutils.pathjoin(cwd, 'foo')
229
445
        self.assertEqual(foo_path, osutils.dereference_path('./foo'))
240
456
        foo_baz_path = osutils.pathjoin(foo_path, 'baz')
241
457
        self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
242
458
 
243
 
 
244
 
class TestSafeUnicode(TestCase):
 
459
    def test_changing_access(self):
 
460
        f = file('file', 'w')
 
461
        f.write('monkey')
 
462
        f.close()
 
463
 
 
464
        # Make a file readonly
 
465
        osutils.make_readonly('file')
 
466
        mode = os.lstat('file').st_mode
 
467
        self.assertEqual(mode, mode & 0777555)
 
468
 
 
469
        # Make a file writable
 
470
        osutils.make_writable('file')
 
471
        mode = os.lstat('file').st_mode
 
472
        self.assertEqual(mode, mode | 0200)
 
473
 
 
474
        if osutils.has_symlinks():
 
475
            # should not error when handed a symlink
 
476
            os.symlink('nonexistent', 'dangling')
 
477
            osutils.make_readonly('dangling')
 
478
            osutils.make_writable('dangling')
 
479
 
 
480
    def test_host_os_dereferences_symlinks(self):
 
481
        osutils.host_os_dereferences_symlinks()
 
482
 
 
483
 
 
484
class TestCanonicalRelPath(tests.TestCaseInTempDir):
 
485
 
 
486
    _test_needs_features = [features.CaseInsCasePresFilenameFeature]
 
487
 
 
488
    def test_canonical_relpath_simple(self):
 
489
        f = file('MixedCaseName', 'w')
 
490
        f.close()
 
491
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
 
492
        self.assertEqual('work/MixedCaseName', actual)
 
493
 
 
494
    def test_canonical_relpath_missing_tail(self):
 
495
        os.mkdir('MixedCaseParent')
 
496
        actual = osutils.canonical_relpath(self.test_base_dir,
 
497
                                           'mixedcaseparent/nochild')
 
498
        self.assertEqual('work/MixedCaseParent/nochild', actual)
 
499
 
 
500
 
 
501
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
 
502
 
 
503
    def assertRelpath(self, expected, base, path):
 
504
        actual = osutils._cicp_canonical_relpath(base, path)
 
505
        self.assertEqual(expected, actual)
 
506
 
 
507
    def test_simple(self):
 
508
        self.build_tree(['MixedCaseName'])
 
509
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
510
        self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
 
511
 
 
512
    def test_subdir_missing_tail(self):
 
513
        self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
 
514
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
515
        self.assertRelpath('MixedCaseParent/a_child', base,
 
516
                           'MixedCaseParent/a_child')
 
517
        self.assertRelpath('MixedCaseParent/a_child', base,
 
518
                           'MixedCaseParent/A_Child')
 
519
        self.assertRelpath('MixedCaseParent/not_child', base,
 
520
                           'MixedCaseParent/not_child')
 
521
 
 
522
    def test_at_root_slash(self):
 
523
        # We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
 
524
        # check...
 
525
        if osutils.MIN_ABS_PATHLENGTH > 1:
 
526
            raise tests.TestSkipped('relpath requires %d chars'
 
527
                                    % osutils.MIN_ABS_PATHLENGTH)
 
528
        self.assertRelpath('foo', '/', '/foo')
 
529
 
 
530
    def test_at_root_drive(self):
 
531
        if sys.platform != 'win32':
 
532
            raise tests.TestNotApplicable('we can only test drive-letter relative'
 
533
                                          ' paths on Windows where we have drive'
 
534
                                          ' letters.')
 
535
        # see bug #322807
 
536
        # The specific issue is that when at the root of a drive, 'abspath'
 
537
        # returns "C:/" or just "/". However, the code assumes that abspath
 
538
        # always returns something like "C:/foo" or "/foo" (no trailing slash).
 
539
        self.assertRelpath('foo', 'C:/', 'C:/foo')
 
540
        self.assertRelpath('foo', 'X:/', 'X:/foo')
 
541
        self.assertRelpath('foo', 'X:/', 'X://foo')
 
542
 
 
543
 
 
544
class TestPumpFile(tests.TestCase):
 
545
    """Test pumpfile method."""
 
546
 
 
547
    def setUp(self):
 
548
        tests.TestCase.setUp(self)
 
549
        # create a test datablock
 
550
        self.block_size = 512
 
551
        pattern = '0123456789ABCDEF'
 
552
        self.test_data = pattern * (3 * self.block_size / len(pattern))
 
553
        self.test_data_len = len(self.test_data)
 
554
 
 
555
    def test_bracket_block_size(self):
 
556
        """Read data in blocks with the requested read size bracketing the
 
557
        block size."""
 
558
        # make sure test data is larger than max read size
 
559
        self.assertTrue(self.test_data_len > self.block_size)
 
560
 
 
561
        from_file = file_utils.FakeReadFile(self.test_data)
 
562
        to_file = StringIO()
 
563
 
 
564
        # read (max / 2) bytes and verify read size wasn't affected
 
565
        num_bytes_to_read = self.block_size / 2
 
566
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
567
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
 
568
        self.assertEqual(from_file.get_read_count(), 1)
 
569
 
 
570
        # read (max) bytes and verify read size wasn't affected
 
571
        num_bytes_to_read = self.block_size
 
572
        from_file.reset_read_count()
 
573
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
574
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
 
575
        self.assertEqual(from_file.get_read_count(), 1)
 
576
 
 
577
        # read (max + 1) bytes and verify read size was limited
 
578
        num_bytes_to_read = self.block_size + 1
 
579
        from_file.reset_read_count()
 
580
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
581
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
582
        self.assertEqual(from_file.get_read_count(), 2)
 
583
 
 
584
        # finish reading the rest of the data
 
585
        num_bytes_to_read = self.test_data_len - to_file.tell()
 
586
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
587
 
 
588
        # report error if the data wasn't equal (we only report the size due
 
589
        # to the length of the data)
 
590
        response_data = to_file.getvalue()
 
591
        if response_data != self.test_data:
 
592
            message = "Data not equal.  Expected %d bytes, received %d."
 
593
            self.fail(message % (len(response_data), self.test_data_len))
 
594
 
 
595
    def test_specified_size(self):
 
596
        """Request a transfer larger than the maximum block size and verify
 
597
        that the maximum read doesn't exceed the block_size."""
 
598
        # make sure test data is larger than max read size
 
599
        self.assertTrue(self.test_data_len > self.block_size)
 
600
 
 
601
        # retrieve data in blocks
 
602
        from_file = file_utils.FakeReadFile(self.test_data)
 
603
        to_file = StringIO()
 
604
        osutils.pumpfile(from_file, to_file, self.test_data_len,
 
605
                         self.block_size)
 
606
 
 
607
        # verify read size was equal to the maximum read size
 
608
        self.assertTrue(from_file.get_max_read_size() > 0)
 
609
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
610
        self.assertEqual(from_file.get_read_count(), 3)
 
611
 
 
612
        # report error if the data wasn't equal (we only report the size due
 
613
        # to the length of the data)
 
614
        response_data = to_file.getvalue()
 
615
        if response_data != self.test_data:
 
616
            message = "Data not equal.  Expected %d bytes, received %d."
 
617
            self.fail(message % (len(response_data), self.test_data_len))
 
618
 
 
619
    def test_to_eof(self):
 
620
        """Read to end-of-file and verify that the reads are not larger than
 
621
        the maximum read size."""
 
622
        # make sure test data is larger than max read size
 
623
        self.assertTrue(self.test_data_len > self.block_size)
 
624
 
 
625
        # retrieve data to EOF
 
626
        from_file = file_utils.FakeReadFile(self.test_data)
 
627
        to_file = StringIO()
 
628
        osutils.pumpfile(from_file, to_file, -1, self.block_size)
 
629
 
 
630
        # verify read size was equal to the maximum read size
 
631
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
632
        self.assertEqual(from_file.get_read_count(), 4)
 
633
 
 
634
        # report error if the data wasn't equal (we only report the size due
 
635
        # to the length of the data)
 
636
        response_data = to_file.getvalue()
 
637
        if response_data != self.test_data:
 
638
            message = "Data not equal.  Expected %d bytes, received %d."
 
639
            self.fail(message % (len(response_data), self.test_data_len))
 
640
 
 
641
    def test_defaults(self):
 
642
        """Verifies that the default arguments will read to EOF -- this
 
643
        test verifies that any existing usages of pumpfile will not be broken
 
644
        with this new version."""
 
645
        # retrieve data using default (old) pumpfile method
 
646
        from_file = file_utils.FakeReadFile(self.test_data)
 
647
        to_file = StringIO()
 
648
        osutils.pumpfile(from_file, to_file)
 
649
 
 
650
        # report error if the data wasn't equal (we only report the size due
 
651
        # to the length of the data)
 
652
        response_data = to_file.getvalue()
 
653
        if response_data != self.test_data:
 
654
            message = "Data not equal.  Expected %d bytes, received %d."
 
655
            self.fail(message % (len(response_data), self.test_data_len))
 
656
 
 
657
    def test_report_activity(self):
 
658
        activity = []
 
659
        def log_activity(length, direction):
 
660
            activity.append((length, direction))
 
661
        from_file = StringIO(self.test_data)
 
662
        to_file = StringIO()
 
663
        osutils.pumpfile(from_file, to_file, buff_size=500,
 
664
                         report_activity=log_activity, direction='read')
 
665
        self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
 
666
                          (36, 'read')], activity)
 
667
 
 
668
        from_file = StringIO(self.test_data)
 
669
        to_file = StringIO()
 
670
        del activity[:]
 
671
        osutils.pumpfile(from_file, to_file, buff_size=500,
 
672
                         report_activity=log_activity, direction='write')
 
673
        self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
 
674
                          (36, 'write')], activity)
 
675
 
 
676
        # And with a limited amount of data
 
677
        from_file = StringIO(self.test_data)
 
678
        to_file = StringIO()
 
679
        del activity[:]
 
680
        osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
 
681
                         report_activity=log_activity, direction='read')
 
682
        self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
 
683
 
 
684
 
 
685
 
 
686
class TestPumpStringFile(tests.TestCase):
 
687
 
 
688
    def test_empty(self):
 
689
        output = StringIO()
 
690
        osutils.pump_string_file("", output)
 
691
        self.assertEqual("", output.getvalue())
 
692
 
 
693
    def test_more_than_segment_size(self):
 
694
        output = StringIO()
 
695
        osutils.pump_string_file("123456789", output, 2)
 
696
        self.assertEqual("123456789", output.getvalue())
 
697
 
 
698
    def test_segment_size(self):
 
699
        output = StringIO()
 
700
        osutils.pump_string_file("12", output, 2)
 
701
        self.assertEqual("12", output.getvalue())
 
702
 
 
703
    def test_segment_size_multiple(self):
 
704
        output = StringIO()
 
705
        osutils.pump_string_file("1234", output, 2)
 
706
        self.assertEqual("1234", output.getvalue())
 
707
 
 
708
 
 
709
class TestRelpath(tests.TestCase):
 
710
 
 
711
    def test_simple_relpath(self):
 
712
        cwd = osutils.getcwd()
 
713
        subdir = cwd + '/subdir'
 
714
        self.assertEqual('subdir', osutils.relpath(cwd, subdir))
 
715
 
 
716
    def test_deep_relpath(self):
 
717
        cwd = osutils.getcwd()
 
718
        subdir = cwd + '/sub/subsubdir'
 
719
        self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
 
720
 
 
721
    def test_not_relative(self):
 
722
        self.assertRaises(errors.PathNotChild,
 
723
                          osutils.relpath, 'C:/path', 'H:/path')
 
724
        self.assertRaises(errors.PathNotChild,
 
725
                          osutils.relpath, 'C:/', 'H:/path')
 
726
 
 
727
 
 
728
class TestSafeUnicode(tests.TestCase):
245
729
 
246
730
    def test_from_ascii_string(self):
247
731
        self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
256
740
        self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
257
741
 
258
742
    def test_bad_utf8_string(self):
259
 
        self.assertRaises(BzrBadParameterNotUnicode,
 
743
        self.assertRaises(errors.BzrBadParameterNotUnicode,
260
744
                          osutils.safe_unicode,
261
745
                          '\xbb\xbb')
262
746
 
263
747
 
264
 
class TestSafeUtf8(TestCase):
 
748
class TestSafeUtf8(tests.TestCase):
265
749
 
266
750
    def test_from_ascii_string(self):
267
751
        f = 'foobar'
277
761
        self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
278
762
 
279
763
    def test_bad_utf8_string(self):
280
 
        self.assertRaises(BzrBadParameterNotUnicode,
 
764
        self.assertRaises(errors.BzrBadParameterNotUnicode,
281
765
                          osutils.safe_utf8, '\xbb\xbb')
282
766
 
283
767
 
284
 
class TestSafeRevisionId(TestCase):
 
768
class TestSafeRevisionId(tests.TestCase):
285
769
 
286
770
    def test_from_ascii_string(self):
287
 
        f = 'foobar'
288
 
        self.assertEqual('foobar', osutils.safe_revision_id(f))
289
 
        self.assertIs(osutils.safe_utf8(f), f)
 
771
        # this shouldn't give a warning because it's getting an ascii string
 
772
        self.assertEqual('foobar', osutils.safe_revision_id('foobar'))
290
773
 
291
774
    def test_from_unicode_string_ascii_contents(self):
292
 
        self.assertEqual('bargam', osutils.safe_revision_id(u'bargam'))
 
775
        self.assertEqual('bargam',
 
776
                         osutils.safe_revision_id(u'bargam', warn=False))
 
777
 
 
778
    def test_from_unicode_deprecated(self):
 
779
        self.assertEqual('bargam',
 
780
            self.callDeprecated([osutils._revision_id_warning],
 
781
                                osutils.safe_revision_id, u'bargam'))
293
782
 
294
783
    def test_from_unicode_string_unicode_contents(self):
295
784
        self.assertEqual('bargam\xc2\xae',
296
 
                         osutils.safe_revision_id(u'bargam\xae'))
 
785
                         osutils.safe_revision_id(u'bargam\xae', warn=False))
297
786
 
298
787
    def test_from_utf8_string(self):
299
788
        self.assertEqual('foo\xc2\xae',
300
789
                         osutils.safe_revision_id('foo\xc2\xae'))
301
790
 
302
 
    def test_bad_utf8_string(self):
303
 
        # This check may eventually go away
304
 
        self.assertRaises(BzrBadParameterNotUnicode,
305
 
                          osutils.safe_utf8, '\xbb\xbb')
306
 
 
307
791
    def test_none(self):
308
792
        """Currently, None is a valid revision_id"""
309
793
        self.assertEqual(None, osutils.safe_revision_id(None))
310
794
 
311
795
 
312
 
class TestWin32Funcs(TestCase):
313
 
    """Test that the _win32 versions of os utilities return appropriate paths."""
 
796
class TestSafeFileId(tests.TestCase):
 
797
 
 
798
    def test_from_ascii_string(self):
 
799
        self.assertEqual('foobar', osutils.safe_file_id('foobar'))
 
800
 
 
801
    def test_from_unicode_string_ascii_contents(self):
 
802
        self.assertEqual('bargam', osutils.safe_file_id(u'bargam', warn=False))
 
803
 
 
804
    def test_from_unicode_deprecated(self):
 
805
        self.assertEqual('bargam',
 
806
            self.callDeprecated([osutils._file_id_warning],
 
807
                                osutils.safe_file_id, u'bargam'))
 
808
 
 
809
    def test_from_unicode_string_unicode_contents(self):
 
810
        self.assertEqual('bargam\xc2\xae',
 
811
                         osutils.safe_file_id(u'bargam\xae', warn=False))
 
812
 
 
813
    def test_from_utf8_string(self):
 
814
        self.assertEqual('foo\xc2\xae',
 
815
                         osutils.safe_file_id('foo\xc2\xae'))
 
816
 
 
817
    def test_none(self):
 
818
        """Currently, None is a valid revision_id"""
 
819
        self.assertEqual(None, osutils.safe_file_id(None))
 
820
 
 
821
 
 
822
class TestPosixFuncs(tests.TestCase):
 
823
    """Test that the posix version of normpath returns an appropriate path
 
824
       when used with 2 leading slashes."""
 
825
 
 
826
    def test_normpath(self):
 
827
        self.assertEqual('/etc/shadow', osutils._posix_normpath('/etc/shadow'))
 
828
        self.assertEqual('/etc/shadow', osutils._posix_normpath('//etc/shadow'))
 
829
        self.assertEqual('/etc/shadow', osutils._posix_normpath('///etc/shadow'))
 
830
 
 
831
 
 
832
class TestWin32Funcs(tests.TestCase):
 
833
    """Test that _win32 versions of os utilities return appropriate paths."""
314
834
 
315
835
    def test_abspath(self):
316
836
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
323
843
        self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
324
844
 
325
845
    def test_pathjoin(self):
326
 
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path', 'to', 'foo'))
327
 
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path\\to', 'C:\\foo'))
328
 
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path/to', 'C:/foo'))
329
 
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path/to/', 'foo'))
330
 
        self.assertEqual('/foo', osutils._win32_pathjoin('C:/path/to/', '/foo'))
331
 
        self.assertEqual('/foo', osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
 
846
        self.assertEqual('path/to/foo',
 
847
                         osutils._win32_pathjoin('path', 'to', 'foo'))
 
848
        self.assertEqual('C:/foo',
 
849
                         osutils._win32_pathjoin('path\\to', 'C:\\foo'))
 
850
        self.assertEqual('C:/foo',
 
851
                         osutils._win32_pathjoin('path/to', 'C:/foo'))
 
852
        self.assertEqual('path/to/foo',
 
853
                         osutils._win32_pathjoin('path/to/', 'foo'))
 
854
        self.assertEqual('/foo',
 
855
                         osutils._win32_pathjoin('C:/path/to/', '/foo'))
 
856
        self.assertEqual('/foo',
 
857
                         osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
332
858
 
333
859
    def test_normpath(self):
334
 
        self.assertEqual('path/to/foo', osutils._win32_normpath(r'path\\from\..\to\.\foo'))
335
 
        self.assertEqual('path/to/foo', osutils._win32_normpath('path//from/../to/./foo'))
 
860
        self.assertEqual('path/to/foo',
 
861
                         osutils._win32_normpath(r'path\\from\..\to\.\foo'))
 
862
        self.assertEqual('path/to/foo',
 
863
                         osutils._win32_normpath('path//from/../to/./foo'))
336
864
 
337
865
    def test_getcwd(self):
338
866
        cwd = osutils._win32_getcwd()
359
887
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
360
888
        # relative path
361
889
        cwd = osutils.getcwd().rstrip('/')
362
 
        drive = osutils._nt_splitdrive(cwd)[0]
 
890
        drive = osutils.ntpath.splitdrive(cwd)[0]
363
891
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
364
892
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
365
893
        # unicode path
367
895
        self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
368
896
 
369
897
 
370
 
class TestWin32FuncsDirs(TestCaseInTempDir):
 
898
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
371
899
    """Test win32 functions that create files."""
372
 
    
 
900
 
373
901
    def test_getcwd(self):
374
 
        if win32utils.winver == 'Windows 98':
375
 
            raise TestSkipped('Windows 98 cannot handle unicode filenames')
376
 
        # Make sure getcwd can handle unicode filenames
377
 
        try:
378
 
            os.mkdir(u'mu-\xb5')
379
 
        except UnicodeError:
380
 
            raise TestSkipped("Unable to create Unicode filename")
381
 
 
 
902
        self.requireFeature(features.UnicodeFilenameFeature)
 
903
        os.mkdir(u'mu-\xb5')
382
904
        os.chdir(u'mu-\xb5')
383
905
        # TODO: jam 20060427 This will probably fail on Mac OSX because
384
906
        #       it will change the normalization of B\xe5gfors
386
908
        #       osutils.getcwd() renormalize the path.
387
909
        self.assertEndsWith(osutils._win32_getcwd(), u'mu-\xb5')
388
910
 
 
911
    def test_minimum_path_selection(self):
 
912
        self.assertEqual(set(),
 
913
            osutils.minimum_path_selection([]))
 
914
        self.assertEqual(set(['a']),
 
915
            osutils.minimum_path_selection(['a']))
 
916
        self.assertEqual(set(['a', 'b']),
 
917
            osutils.minimum_path_selection(['a', 'b']))
 
918
        self.assertEqual(set(['a/', 'b']),
 
919
            osutils.minimum_path_selection(['a/', 'b']))
 
920
        self.assertEqual(set(['a/', 'b']),
 
921
            osutils.minimum_path_selection(['a/c', 'a/', 'b']))
 
922
        self.assertEqual(set(['a-b', 'a', 'a0b']),
 
923
            osutils.minimum_path_selection(['a-b', 'a/b', 'a0b', 'a']))
 
924
 
389
925
    def test_mkdtemp(self):
390
926
        tmpdir = osutils._win32_mkdtemp(dir='.')
391
927
        self.assertFalse('\\' in tmpdir)
399
935
        b.close()
400
936
 
401
937
        osutils._win32_rename('b', 'a')
402
 
        self.failUnlessExists('a')
403
 
        self.failIfExists('b')
 
938
        self.assertPathExists('a')
 
939
        self.assertPathDoesNotExist('b')
404
940
        self.assertFileEqual('baz\n', 'a')
405
941
 
406
942
    def test_rename_missing_file(self):
446
982
        self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
447
983
 
448
984
 
449
 
class TestMacFuncsDirs(TestCaseInTempDir):
 
985
class TestParentDirectories(tests.TestCaseInTempDir):
 
986
    """Test osutils.parent_directories()"""
 
987
 
 
988
    def test_parent_directories(self):
 
989
        self.assertEqual([], osutils.parent_directories('a'))
 
990
        self.assertEqual(['a'], osutils.parent_directories('a/b'))
 
991
        self.assertEqual(['a/b', 'a'], osutils.parent_directories('a/b/c'))
 
992
 
 
993
 
 
994
class TestMacFuncsDirs(tests.TestCaseInTempDir):
450
995
    """Test mac special functions that require directories."""
451
996
 
452
997
    def test_getcwd(self):
453
 
        # On Mac, this will actually create Ba\u030agfors
454
 
        # but chdir will still work, because it accepts both paths
455
 
        try:
456
 
            os.mkdir(u'B\xe5gfors')
457
 
        except UnicodeError:
458
 
            raise TestSkipped("Unable to create Unicode filename")
459
 
 
 
998
        self.requireFeature(features.UnicodeFilenameFeature)
 
999
        os.mkdir(u'B\xe5gfors')
460
1000
        os.chdir(u'B\xe5gfors')
461
1001
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
462
1002
 
463
1003
    def test_getcwd_nonnorm(self):
 
1004
        self.requireFeature(features.UnicodeFilenameFeature)
464
1005
        # Test that _mac_getcwd() will normalize this path
465
 
        try:
466
 
            os.mkdir(u'Ba\u030agfors')
467
 
        except UnicodeError:
468
 
            raise TestSkipped("Unable to create Unicode filename")
469
 
 
 
1006
        os.mkdir(u'Ba\u030agfors')
470
1007
        os.chdir(u'Ba\u030agfors')
471
1008
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
472
1009
 
473
1010
 
474
 
class TestSplitLines(TestCase):
 
1011
class TestChunksToLines(tests.TestCase):
 
1012
 
 
1013
    def test_smoketest(self):
 
1014
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
 
1015
                         osutils.chunks_to_lines(['foo\nbar', '\nbaz\n']))
 
1016
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
 
1017
                         osutils.chunks_to_lines(['foo\n', 'bar\n', 'baz\n']))
 
1018
 
 
1019
    def test_osutils_binding(self):
 
1020
        from bzrlib.tests import test__chunks_to_lines
 
1021
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
 
1022
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1023
        else:
 
1024
            from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1025
        self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
 
1026
 
 
1027
 
 
1028
class TestSplitLines(tests.TestCase):
475
1029
 
476
1030
    def test_split_unicode(self):
477
1031
        self.assertEqual([u'foo\n', u'bar\xae'],
484
1038
                         osutils.split_lines('foo\rbar\n'))
485
1039
 
486
1040
 
487
 
class TestWalkDirs(TestCaseInTempDir):
 
1041
class TestWalkDirs(tests.TestCaseInTempDir):
 
1042
 
 
1043
    def assertExpectedBlocks(self, expected, result):
 
1044
        self.assertEqual(expected,
 
1045
                         [(dirinfo, [line[0:3] for line in block])
 
1046
                          for dirinfo, block in result])
488
1047
 
489
1048
    def test_walkdirs(self):
490
1049
        tree = [
523
1082
            result.append((dirdetail, dirblock))
524
1083
 
525
1084
        self.assertTrue(found_bzrdir)
526
 
        self.assertEqual(expected_dirblocks,
527
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
528
 
        # you can search a subdir only, with a supplied prefix.
529
 
        result = []
530
 
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
531
 
            result.append(dirblock)
532
 
        self.assertEqual(expected_dirblocks[1:],
533
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1085
        self.assertExpectedBlocks(expected_dirblocks, result)
 
1086
        # you can search a subdir only, with a supplied prefix.
 
1087
        result = []
 
1088
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
 
1089
            result.append(dirblock)
 
1090
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
 
1091
 
 
1092
    def test_walkdirs_os_error(self):
 
1093
        # <https://bugs.launchpad.net/bzr/+bug/338653>
 
1094
        # Pyrex readdir didn't raise useful messages if it had an error
 
1095
        # reading the directory
 
1096
        if sys.platform == 'win32':
 
1097
            raise tests.TestNotApplicable(
 
1098
                "readdir IOError not tested on win32")
 
1099
        self.requireFeature(features.not_running_as_root)
 
1100
        os.mkdir("test-unreadable")
 
1101
        os.chmod("test-unreadable", 0000)
 
1102
        # must chmod it back so that it can be removed
 
1103
        self.addCleanup(os.chmod, "test-unreadable", 0700)
 
1104
        # The error is not raised until the generator is actually evaluated.
 
1105
        # (It would be ok if it happened earlier but at the moment it
 
1106
        # doesn't.)
 
1107
        e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
 
1108
        self.assertEquals('./test-unreadable', e.filename)
 
1109
        self.assertEquals(errno.EACCES, e.errno)
 
1110
        # Ensure the message contains the file name
 
1111
        self.assertContainsRe(str(e), "\./test-unreadable")
 
1112
 
 
1113
 
 
1114
    def test_walkdirs_encoding_error(self):
 
1115
        # <https://bugs.launchpad.net/bzr/+bug/488519>
 
1116
        # walkdirs didn't raise a useful message when the filenames
 
1117
        # are not using the filesystem's encoding
 
1118
 
 
1119
        # require a bytestring based filesystem
 
1120
        self.requireFeature(features.ByteStringNamedFilesystem)
 
1121
 
 
1122
        tree = [
 
1123
            '.bzr',
 
1124
            '0file',
 
1125
            '1dir/',
 
1126
            '1dir/0file',
 
1127
            '1dir/1dir/',
 
1128
            '1file'
 
1129
            ]
 
1130
 
 
1131
        self.build_tree(tree)
 
1132
 
 
1133
        # rename the 1file to a latin-1 filename
 
1134
        os.rename("./1file", "\xe8file")
 
1135
        if "\xe8file" not in os.listdir("."):
 
1136
            self.skip("Lack filesystem that preserves arbitrary bytes")
 
1137
 
 
1138
        self._save_platform_info()
 
1139
        win32utils.winver = None # Avoid the win32 detection code
 
1140
        osutils._fs_enc = 'UTF-8'
 
1141
 
 
1142
        # this should raise on error
 
1143
        def attempt():
 
1144
            for dirdetail, dirblock in osutils.walkdirs('.'):
 
1145
                pass
 
1146
 
 
1147
        self.assertRaises(errors.BadFilenameEncoding, attempt)
 
1148
 
 
1149
    def test__walkdirs_utf8(self):
 
1150
        tree = [
 
1151
            '.bzr',
 
1152
            '0file',
 
1153
            '1dir/',
 
1154
            '1dir/0file',
 
1155
            '1dir/1dir/',
 
1156
            '2file'
 
1157
            ]
 
1158
        self.build_tree(tree)
 
1159
        expected_dirblocks = [
 
1160
                (('', '.'),
 
1161
                 [('0file', '0file', 'file'),
 
1162
                  ('1dir', '1dir', 'directory'),
 
1163
                  ('2file', '2file', 'file'),
 
1164
                 ]
 
1165
                ),
 
1166
                (('1dir', './1dir'),
 
1167
                 [('1dir/0file', '0file', 'file'),
 
1168
                  ('1dir/1dir', '1dir', 'directory'),
 
1169
                 ]
 
1170
                ),
 
1171
                (('1dir/1dir', './1dir/1dir'),
 
1172
                 [
 
1173
                 ]
 
1174
                ),
 
1175
            ]
 
1176
        result = []
 
1177
        found_bzrdir = False
 
1178
        for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
 
1179
            if len(dirblock) and dirblock[0][1] == '.bzr':
 
1180
                # this tests the filtering of selected paths
 
1181
                found_bzrdir = True
 
1182
                del dirblock[0]
 
1183
            result.append((dirdetail, dirblock))
 
1184
 
 
1185
        self.assertTrue(found_bzrdir)
 
1186
        self.assertExpectedBlocks(expected_dirblocks, result)
 
1187
 
 
1188
        # you can search a subdir only, with a supplied prefix.
 
1189
        result = []
 
1190
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
 
1191
            result.append(dirblock)
 
1192
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
 
1193
 
 
1194
    def _filter_out_stat(self, result):
 
1195
        """Filter out the stat value from the walkdirs result"""
 
1196
        for dirdetail, dirblock in result:
 
1197
            new_dirblock = []
 
1198
            for info in dirblock:
 
1199
                # Ignore info[3] which is the stat
 
1200
                new_dirblock.append((info[0], info[1], info[2], info[4]))
 
1201
            dirblock[:] = new_dirblock
 
1202
 
 
1203
    def _save_platform_info(self):
 
1204
        self.overrideAttr(win32utils, 'winver')
 
1205
        self.overrideAttr(osutils, '_fs_enc')
 
1206
        self.overrideAttr(osutils, '_selected_dir_reader')
 
1207
 
 
1208
    def assertDirReaderIs(self, expected):
 
1209
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
 
1210
        # Force it to redetect
 
1211
        osutils._selected_dir_reader = None
 
1212
        # Nothing to list, but should still trigger the selection logic
 
1213
        self.assertEqual([(('', '.'), [])], list(osutils._walkdirs_utf8('.')))
 
1214
        self.assertIsInstance(osutils._selected_dir_reader, expected)
 
1215
 
 
1216
    def test_force_walkdirs_utf8_fs_utf8(self):
 
1217
        self.requireFeature(UTF8DirReaderFeature)
 
1218
        self._save_platform_info()
 
1219
        win32utils.winver = None # Avoid the win32 detection code
 
1220
        osutils._fs_enc = 'UTF-8'
 
1221
        self.assertDirReaderIs(
 
1222
            UTF8DirReaderFeature.module.UTF8DirReader)
 
1223
 
 
1224
    def test_force_walkdirs_utf8_fs_ascii(self):
 
1225
        self.requireFeature(UTF8DirReaderFeature)
 
1226
        self._save_platform_info()
 
1227
        win32utils.winver = None # Avoid the win32 detection code
 
1228
        osutils._fs_enc = 'US-ASCII'
 
1229
        self.assertDirReaderIs(
 
1230
            UTF8DirReaderFeature.module.UTF8DirReader)
 
1231
 
 
1232
    def test_force_walkdirs_utf8_fs_ANSI(self):
 
1233
        self.requireFeature(UTF8DirReaderFeature)
 
1234
        self._save_platform_info()
 
1235
        win32utils.winver = None # Avoid the win32 detection code
 
1236
        osutils._fs_enc = 'ANSI_X3.4-1968'
 
1237
        self.assertDirReaderIs(
 
1238
            UTF8DirReaderFeature.module.UTF8DirReader)
 
1239
 
 
1240
    def test_force_walkdirs_utf8_fs_latin1(self):
 
1241
        self._save_platform_info()
 
1242
        win32utils.winver = None # Avoid the win32 detection code
 
1243
        osutils._fs_enc = 'latin1'
 
1244
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
1245
 
 
1246
    def test_force_walkdirs_utf8_nt(self):
 
1247
        # Disabled because the thunk of the whole walkdirs api is disabled.
 
1248
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1249
        self._save_platform_info()
 
1250
        win32utils.winver = 'Windows NT'
 
1251
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1252
        self.assertDirReaderIs(Win32ReadDir)
 
1253
 
 
1254
    def test_force_walkdirs_utf8_98(self):
 
1255
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1256
        self._save_platform_info()
 
1257
        win32utils.winver = 'Windows 98'
 
1258
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
1259
 
 
1260
    def test_unicode_walkdirs(self):
 
1261
        """Walkdirs should always return unicode paths."""
 
1262
        self.requireFeature(features.UnicodeFilenameFeature)
 
1263
        name0 = u'0file-\xb6'
 
1264
        name1 = u'1dir-\u062c\u0648'
 
1265
        name2 = u'2file-\u0633'
 
1266
        tree = [
 
1267
            name0,
 
1268
            name1 + '/',
 
1269
            name1 + '/' + name0,
 
1270
            name1 + '/' + name1 + '/',
 
1271
            name2,
 
1272
            ]
 
1273
        self.build_tree(tree)
 
1274
        expected_dirblocks = [
 
1275
                ((u'', u'.'),
 
1276
                 [(name0, name0, 'file', './' + name0),
 
1277
                  (name1, name1, 'directory', './' + name1),
 
1278
                  (name2, name2, 'file', './' + name2),
 
1279
                 ]
 
1280
                ),
 
1281
                ((name1, './' + name1),
 
1282
                 [(name1 + '/' + name0, name0, 'file', './' + name1
 
1283
                                                        + '/' + name0),
 
1284
                  (name1 + '/' + name1, name1, 'directory', './' + name1
 
1285
                                                            + '/' + name1),
 
1286
                 ]
 
1287
                ),
 
1288
                ((name1 + '/' + name1, './' + name1 + '/' + name1),
 
1289
                 [
 
1290
                 ]
 
1291
                ),
 
1292
            ]
 
1293
        result = list(osutils.walkdirs('.'))
 
1294
        self._filter_out_stat(result)
 
1295
        self.assertEqual(expected_dirblocks, result)
 
1296
        result = list(osutils.walkdirs(u'./'+name1, name1))
 
1297
        self._filter_out_stat(result)
 
1298
        self.assertEqual(expected_dirblocks[1:], result)
 
1299
 
 
1300
    def test_unicode__walkdirs_utf8(self):
 
1301
        """Walkdirs_utf8 should always return utf8 paths.
 
1302
 
 
1303
        The abspath portion might be in unicode or utf-8
 
1304
        """
 
1305
        self.requireFeature(features.UnicodeFilenameFeature)
 
1306
        name0 = u'0file-\xb6'
 
1307
        name1 = u'1dir-\u062c\u0648'
 
1308
        name2 = u'2file-\u0633'
 
1309
        tree = [
 
1310
            name0,
 
1311
            name1 + '/',
 
1312
            name1 + '/' + name0,
 
1313
            name1 + '/' + name1 + '/',
 
1314
            name2,
 
1315
            ]
 
1316
        self.build_tree(tree)
 
1317
        name0 = name0.encode('utf8')
 
1318
        name1 = name1.encode('utf8')
 
1319
        name2 = name2.encode('utf8')
 
1320
 
 
1321
        expected_dirblocks = [
 
1322
                (('', '.'),
 
1323
                 [(name0, name0, 'file', './' + name0),
 
1324
                  (name1, name1, 'directory', './' + name1),
 
1325
                  (name2, name2, 'file', './' + name2),
 
1326
                 ]
 
1327
                ),
 
1328
                ((name1, './' + name1),
 
1329
                 [(name1 + '/' + name0, name0, 'file', './' + name1
 
1330
                                                        + '/' + name0),
 
1331
                  (name1 + '/' + name1, name1, 'directory', './' + name1
 
1332
                                                            + '/' + name1),
 
1333
                 ]
 
1334
                ),
 
1335
                ((name1 + '/' + name1, './' + name1 + '/' + name1),
 
1336
                 [
 
1337
                 ]
 
1338
                ),
 
1339
            ]
 
1340
        result = []
 
1341
        # For ease in testing, if walkdirs_utf8 returns Unicode, assert that
 
1342
        # all abspaths are Unicode, and encode them back into utf8.
 
1343
        for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
 
1344
            self.assertIsInstance(dirdetail[0], str)
 
1345
            if isinstance(dirdetail[1], unicode):
 
1346
                dirdetail = (dirdetail[0], dirdetail[1].encode('utf8'))
 
1347
                dirblock = [list(info) for info in dirblock]
 
1348
                for info in dirblock:
 
1349
                    self.assertIsInstance(info[4], unicode)
 
1350
                    info[4] = info[4].encode('utf8')
 
1351
            new_dirblock = []
 
1352
            for info in dirblock:
 
1353
                self.assertIsInstance(info[0], str)
 
1354
                self.assertIsInstance(info[1], str)
 
1355
                self.assertIsInstance(info[4], str)
 
1356
                # Remove the stat information
 
1357
                new_dirblock.append((info[0], info[1], info[2], info[4]))
 
1358
            result.append((dirdetail, new_dirblock))
 
1359
        self.assertEqual(expected_dirblocks, result)
 
1360
 
 
1361
    def test__walkdirs_utf8_with_unicode_fs(self):
 
1362
        """UnicodeDirReader should be a safe fallback everywhere
 
1363
 
 
1364
        The abspath portion should be in unicode
 
1365
        """
 
1366
        self.requireFeature(features.UnicodeFilenameFeature)
 
1367
        # Use the unicode reader. TODO: split into driver-and-driven unit
 
1368
        # tests.
 
1369
        self._save_platform_info()
 
1370
        osutils._selected_dir_reader = osutils.UnicodeDirReader()
 
1371
        name0u = u'0file-\xb6'
 
1372
        name1u = u'1dir-\u062c\u0648'
 
1373
        name2u = u'2file-\u0633'
 
1374
        tree = [
 
1375
            name0u,
 
1376
            name1u + '/',
 
1377
            name1u + '/' + name0u,
 
1378
            name1u + '/' + name1u + '/',
 
1379
            name2u,
 
1380
            ]
 
1381
        self.build_tree(tree)
 
1382
        name0 = name0u.encode('utf8')
 
1383
        name1 = name1u.encode('utf8')
 
1384
        name2 = name2u.encode('utf8')
 
1385
 
 
1386
        # All of the abspaths should be in unicode, all of the relative paths
 
1387
        # should be in utf8
 
1388
        expected_dirblocks = [
 
1389
                (('', '.'),
 
1390
                 [(name0, name0, 'file', './' + name0u),
 
1391
                  (name1, name1, 'directory', './' + name1u),
 
1392
                  (name2, name2, 'file', './' + name2u),
 
1393
                 ]
 
1394
                ),
 
1395
                ((name1, './' + name1u),
 
1396
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1397
                                                        + '/' + name0u),
 
1398
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1399
                                                            + '/' + name1u),
 
1400
                 ]
 
1401
                ),
 
1402
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1403
                 [
 
1404
                 ]
 
1405
                ),
 
1406
            ]
 
1407
        result = list(osutils._walkdirs_utf8('.'))
 
1408
        self._filter_out_stat(result)
 
1409
        self.assertEqual(expected_dirblocks, result)
 
1410
 
 
1411
    def test__walkdirs_utf8_win32readdir(self):
 
1412
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1413
        self.requireFeature(features.UnicodeFilenameFeature)
 
1414
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1415
        self._save_platform_info()
 
1416
        osutils._selected_dir_reader = Win32ReadDir()
 
1417
        name0u = u'0file-\xb6'
 
1418
        name1u = u'1dir-\u062c\u0648'
 
1419
        name2u = u'2file-\u0633'
 
1420
        tree = [
 
1421
            name0u,
 
1422
            name1u + '/',
 
1423
            name1u + '/' + name0u,
 
1424
            name1u + '/' + name1u + '/',
 
1425
            name2u,
 
1426
            ]
 
1427
        self.build_tree(tree)
 
1428
        name0 = name0u.encode('utf8')
 
1429
        name1 = name1u.encode('utf8')
 
1430
        name2 = name2u.encode('utf8')
 
1431
 
 
1432
        # All of the abspaths should be in unicode, all of the relative paths
 
1433
        # should be in utf8
 
1434
        expected_dirblocks = [
 
1435
                (('', '.'),
 
1436
                 [(name0, name0, 'file', './' + name0u),
 
1437
                  (name1, name1, 'directory', './' + name1u),
 
1438
                  (name2, name2, 'file', './' + name2u),
 
1439
                 ]
 
1440
                ),
 
1441
                ((name1, './' + name1u),
 
1442
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1443
                                                        + '/' + name0u),
 
1444
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1445
                                                            + '/' + name1u),
 
1446
                 ]
 
1447
                ),
 
1448
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1449
                 [
 
1450
                 ]
 
1451
                ),
 
1452
            ]
 
1453
        result = list(osutils._walkdirs_utf8(u'.'))
 
1454
        self._filter_out_stat(result)
 
1455
        self.assertEqual(expected_dirblocks, result)
 
1456
 
 
1457
    def assertStatIsCorrect(self, path, win32stat):
 
1458
        os_stat = os.stat(path)
 
1459
        self.assertEqual(os_stat.st_size, win32stat.st_size)
 
1460
        self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
 
1461
        self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
 
1462
        self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
 
1463
        self.assertEqual(os_stat.st_dev, win32stat.st_dev)
 
1464
        self.assertEqual(os_stat.st_ino, win32stat.st_ino)
 
1465
        self.assertEqual(os_stat.st_mode, win32stat.st_mode)
 
1466
 
 
1467
    def test__walkdirs_utf_win32_find_file_stat_file(self):
 
1468
        """make sure our Stat values are valid"""
 
1469
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1470
        self.requireFeature(features.UnicodeFilenameFeature)
 
1471
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1472
        name0u = u'0file-\xb6'
 
1473
        name0 = name0u.encode('utf8')
 
1474
        self.build_tree([name0u])
 
1475
        # I hate to sleep() here, but I'm trying to make the ctime different
 
1476
        # from the mtime
 
1477
        time.sleep(2)
 
1478
        f = open(name0u, 'ab')
 
1479
        try:
 
1480
            f.write('just a small update')
 
1481
        finally:
 
1482
            f.close()
 
1483
 
 
1484
        result = Win32ReadDir().read_dir('', u'.')
 
1485
        entry = result[0]
 
1486
        self.assertEqual((name0, name0, 'file'), entry[:3])
 
1487
        self.assertEqual(u'./' + name0u, entry[4])
 
1488
        self.assertStatIsCorrect(entry[4], entry[3])
 
1489
        self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
 
1490
 
 
1491
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
 
1492
        """make sure our Stat values are valid"""
 
1493
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1494
        self.requireFeature(features.UnicodeFilenameFeature)
 
1495
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1496
        name0u = u'0dir-\u062c\u0648'
 
1497
        name0 = name0u.encode('utf8')
 
1498
        self.build_tree([name0u + '/'])
 
1499
 
 
1500
        result = Win32ReadDir().read_dir('', u'.')
 
1501
        entry = result[0]
 
1502
        self.assertEqual((name0, name0, 'directory'), entry[:3])
 
1503
        self.assertEqual(u'./' + name0u, entry[4])
 
1504
        self.assertStatIsCorrect(entry[4], entry[3])
534
1505
 
535
1506
    def assertPathCompare(self, path_less, path_greater):
536
1507
        """check that path_less and path_greater compare correctly."""
610
1581
            sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
611
1582
 
612
1583
 
613
 
class TestCopyTree(TestCaseInTempDir):
614
 
    
 
1584
class TestCopyTree(tests.TestCaseInTempDir):
 
1585
 
615
1586
    def test_copy_basic_tree(self):
616
1587
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
617
1588
        osutils.copy_tree('source', 'target')
626
1597
        self.assertEqual(['c'], os.listdir('target/b'))
627
1598
 
628
1599
    def test_copy_tree_symlinks(self):
629
 
        if not osutils.has_symlinks():
630
 
            return
 
1600
        self.requireFeature(features.SymlinkFeature)
631
1601
        self.build_tree(['source/'])
632
1602
        os.symlink('a/generic/path', 'source/lnk')
633
1603
        osutils.copy_tree('source', 'target')
658
1628
                          ('d', 'source/b', 'target/b'),
659
1629
                          ('f', 'source/b/c', 'target/b/c'),
660
1630
                         ], processed_files)
661
 
        self.failIfExists('target')
 
1631
        self.assertPathDoesNotExist('target')
662
1632
        if osutils.has_symlinks():
663
1633
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
664
1634
 
665
1635
 
666
 
#class TestTerminalEncoding has been moved to test_osutils_encodings.py
667
 
# [bialix] 2006/12/26
668
 
 
669
 
 
670
 
class TestSetUnsetEnv(TestCase):
 
1636
class TestSetUnsetEnv(tests.TestCase):
671
1637
    """Test updating the environment"""
672
1638
 
673
1639
    def setUp(self):
679
1645
        def cleanup():
680
1646
            if 'BZR_TEST_ENV_VAR' in os.environ:
681
1647
                del os.environ['BZR_TEST_ENV_VAR']
682
 
 
683
1648
        self.addCleanup(cleanup)
684
1649
 
685
1650
    def test_set(self):
697
1662
 
698
1663
    def test_unicode(self):
699
1664
        """Environment can only contain plain strings
700
 
        
 
1665
 
701
1666
        So Unicode strings must be encoded.
702
1667
        """
703
 
        # Try a few different characters, to see if we can get
704
 
        # one that will be valid in the user_encoding
705
 
        possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
706
 
        for uni_val in possible_vals:
707
 
            try:
708
 
                env_val = uni_val.encode(bzrlib.user_encoding)
709
 
            except UnicodeEncodeError:
710
 
                # Try a different character
711
 
                pass
712
 
            else:
713
 
                break
714
 
        else:
715
 
            raise TestSkipped('Cannot find a unicode character that works in'
716
 
                              ' encoding %s' % (bzrlib.user_encoding,))
 
1668
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
1669
        if uni_val is None:
 
1670
            raise tests.TestSkipped(
 
1671
                'Cannot find a unicode character that works in encoding %s'
 
1672
                % (osutils.get_user_encoding(),))
717
1673
 
718
1674
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
719
1675
        self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
724
1680
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
725
1681
        self.assertEqual('foo', old)
726
1682
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
727
 
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
728
 
 
729
 
 
730
 
class TestLocalTimeOffset(TestCase):
731
 
 
732
 
    def test_local_time_offset(self):
733
 
        """Test that local_time_offset() returns a sane value."""
734
 
        offset = osutils.local_time_offset()
735
 
        self.assertTrue(isinstance(offset, int))
736
 
        # Test that the offset is no more than a eighteen hours in
737
 
        # either direction.
738
 
        # Time zone handling is system specific, so it is difficult to
739
 
        # do more specific tests, but a value outside of this range is
740
 
        # probably wrong.
741
 
        eighteen_hours = 18 * 3600
742
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
743
 
 
744
 
    def test_local_time_offset_with_timestamp(self):
745
 
        """Test that local_time_offset() works with a timestamp."""
746
 
        offset = osutils.local_time_offset(1000000000.1234567)
747
 
        self.assertTrue(isinstance(offset, int))
748
 
        eighteen_hours = 18 * 3600
749
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
1683
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
 
1684
 
 
1685
 
 
1686
class TestSizeShaFile(tests.TestCaseInTempDir):
 
1687
 
 
1688
    def test_sha_empty(self):
 
1689
        self.build_tree_contents([('foo', '')])
 
1690
        expected_sha = osutils.sha_string('')
 
1691
        f = open('foo')
 
1692
        self.addCleanup(f.close)
 
1693
        size, sha = osutils.size_sha_file(f)
 
1694
        self.assertEqual(0, size)
 
1695
        self.assertEqual(expected_sha, sha)
 
1696
 
 
1697
    def test_sha_mixed_endings(self):
 
1698
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1699
        self.build_tree_contents([('foo', text)])
 
1700
        expected_sha = osutils.sha_string(text)
 
1701
        f = open('foo', 'rb')
 
1702
        self.addCleanup(f.close)
 
1703
        size, sha = osutils.size_sha_file(f)
 
1704
        self.assertEqual(38, size)
 
1705
        self.assertEqual(expected_sha, sha)
 
1706
 
 
1707
 
 
1708
class TestShaFileByName(tests.TestCaseInTempDir):
 
1709
 
 
1710
    def test_sha_empty(self):
 
1711
        self.build_tree_contents([('foo', '')])
 
1712
        expected_sha = osutils.sha_string('')
 
1713
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1714
 
 
1715
    def test_sha_mixed_endings(self):
 
1716
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1717
        self.build_tree_contents([('foo', text)])
 
1718
        expected_sha = osutils.sha_string(text)
 
1719
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1720
 
 
1721
 
 
1722
class TestResourceLoading(tests.TestCaseInTempDir):
 
1723
 
 
1724
    def test_resource_string(self):
 
1725
        # test resource in bzrlib
 
1726
        text = osutils.resource_string('bzrlib', 'debug.py')
 
1727
        self.assertContainsRe(text, "debug_flags = set()")
 
1728
        # test resource under bzrlib
 
1729
        text = osutils.resource_string('bzrlib.ui', 'text.py')
 
1730
        self.assertContainsRe(text, "class TextUIFactory")
 
1731
        # test unsupported package
 
1732
        self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
 
1733
            'yyy.xx')
 
1734
        # test unknown resource
 
1735
        self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
 
1736
 
 
1737
 
 
1738
class TestReCompile(tests.TestCase):
 
1739
 
 
1740
    def _deprecated_re_compile_checked(self, *args, **kwargs):
 
1741
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
 
1742
            osutils.re_compile_checked, *args, **kwargs)
 
1743
 
 
1744
    def test_re_compile_checked(self):
 
1745
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
 
1746
        self.assertTrue(r.match('aaaa'))
 
1747
        self.assertTrue(r.match('aAaA'))
 
1748
 
 
1749
    def test_re_compile_checked_error(self):
 
1750
        # like https://bugs.launchpad.net/bzr/+bug/251352
 
1751
 
 
1752
        # Due to possible test isolation error, re.compile is not lazy at
 
1753
        # this point. We re-install lazy compile.
 
1754
        lazy_regex.install_lazy_compile()
 
1755
        err = self.assertRaises(
 
1756
            errors.BzrCommandError,
 
1757
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1758
        self.assertEqual(
 
1759
            'Invalid regular expression in test case: '
 
1760
            '"*" nothing to repeat',
 
1761
            str(err))
 
1762
 
 
1763
 
 
1764
class TestDirReader(tests.TestCaseInTempDir):
 
1765
 
 
1766
    scenarios = dir_reader_scenarios()
 
1767
 
 
1768
    # Set by load_tests
 
1769
    _dir_reader_class = None
 
1770
    _native_to_unicode = None
 
1771
 
 
1772
    def setUp(self):
 
1773
        tests.TestCaseInTempDir.setUp(self)
 
1774
        self.overrideAttr(osutils,
 
1775
                          '_selected_dir_reader', self._dir_reader_class())
 
1776
 
 
1777
    def _get_ascii_tree(self):
 
1778
        tree = [
 
1779
            '0file',
 
1780
            '1dir/',
 
1781
            '1dir/0file',
 
1782
            '1dir/1dir/',
 
1783
            '2file'
 
1784
            ]
 
1785
        expected_dirblocks = [
 
1786
                (('', '.'),
 
1787
                 [('0file', '0file', 'file'),
 
1788
                  ('1dir', '1dir', 'directory'),
 
1789
                  ('2file', '2file', 'file'),
 
1790
                 ]
 
1791
                ),
 
1792
                (('1dir', './1dir'),
 
1793
                 [('1dir/0file', '0file', 'file'),
 
1794
                  ('1dir/1dir', '1dir', 'directory'),
 
1795
                 ]
 
1796
                ),
 
1797
                (('1dir/1dir', './1dir/1dir'),
 
1798
                 [
 
1799
                 ]
 
1800
                ),
 
1801
            ]
 
1802
        return tree, expected_dirblocks
 
1803
 
 
1804
    def test_walk_cur_dir(self):
 
1805
        tree, expected_dirblocks = self._get_ascii_tree()
 
1806
        self.build_tree(tree)
 
1807
        result = list(osutils._walkdirs_utf8('.'))
 
1808
        # Filter out stat and abspath
 
1809
        self.assertEqual(expected_dirblocks,
 
1810
                         [(dirinfo, [line[0:3] for line in block])
 
1811
                          for dirinfo, block in result])
 
1812
 
 
1813
    def test_walk_sub_dir(self):
 
1814
        tree, expected_dirblocks = self._get_ascii_tree()
 
1815
        self.build_tree(tree)
 
1816
        # you can search a subdir only, with a supplied prefix.
 
1817
        result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
 
1818
        # Filter out stat and abspath
 
1819
        self.assertEqual(expected_dirblocks[1:],
 
1820
                         [(dirinfo, [line[0:3] for line in block])
 
1821
                          for dirinfo, block in result])
 
1822
 
 
1823
    def _get_unicode_tree(self):
 
1824
        name0u = u'0file-\xb6'
 
1825
        name1u = u'1dir-\u062c\u0648'
 
1826
        name2u = u'2file-\u0633'
 
1827
        tree = [
 
1828
            name0u,
 
1829
            name1u + '/',
 
1830
            name1u + '/' + name0u,
 
1831
            name1u + '/' + name1u + '/',
 
1832
            name2u,
 
1833
            ]
 
1834
        name0 = name0u.encode('UTF-8')
 
1835
        name1 = name1u.encode('UTF-8')
 
1836
        name2 = name2u.encode('UTF-8')
 
1837
        expected_dirblocks = [
 
1838
                (('', '.'),
 
1839
                 [(name0, name0, 'file', './' + name0u),
 
1840
                  (name1, name1, 'directory', './' + name1u),
 
1841
                  (name2, name2, 'file', './' + name2u),
 
1842
                 ]
 
1843
                ),
 
1844
                ((name1, './' + name1u),
 
1845
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1846
                                                        + '/' + name0u),
 
1847
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1848
                                                            + '/' + name1u),
 
1849
                 ]
 
1850
                ),
 
1851
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1852
                 [
 
1853
                 ]
 
1854
                ),
 
1855
            ]
 
1856
        return tree, expected_dirblocks
 
1857
 
 
1858
    def _filter_out(self, raw_dirblocks):
 
1859
        """Filter out a walkdirs_utf8 result.
 
1860
 
 
1861
        stat field is removed, all native paths are converted to unicode
 
1862
        """
 
1863
        filtered_dirblocks = []
 
1864
        for dirinfo, block in raw_dirblocks:
 
1865
            dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
 
1866
            details = []
 
1867
            for line in block:
 
1868
                details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
 
1869
            filtered_dirblocks.append((dirinfo, details))
 
1870
        return filtered_dirblocks
 
1871
 
 
1872
    def test_walk_unicode_tree(self):
 
1873
        self.requireFeature(features.UnicodeFilenameFeature)
 
1874
        tree, expected_dirblocks = self._get_unicode_tree()
 
1875
        self.build_tree(tree)
 
1876
        result = list(osutils._walkdirs_utf8('.'))
 
1877
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1878
 
 
1879
    def test_symlink(self):
 
1880
        self.requireFeature(features.SymlinkFeature)
 
1881
        self.requireFeature(features.UnicodeFilenameFeature)
 
1882
        target = u'target\N{Euro Sign}'
 
1883
        link_name = u'l\N{Euro Sign}nk'
 
1884
        os.symlink(target, link_name)
 
1885
        target_utf8 = target.encode('UTF-8')
 
1886
        link_name_utf8 = link_name.encode('UTF-8')
 
1887
        expected_dirblocks = [
 
1888
                (('', '.'),
 
1889
                 [(link_name_utf8, link_name_utf8,
 
1890
                   'symlink', './' + link_name),],
 
1891
                 )]
 
1892
        result = list(osutils._walkdirs_utf8('.'))
 
1893
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1894
 
 
1895
 
 
1896
class TestReadLink(tests.TestCaseInTempDir):
 
1897
    """Exposes os.readlink() problems and the osutils solution.
 
1898
 
 
1899
    The only guarantee offered by os.readlink(), starting with 2.6, is that a
 
1900
    unicode string will be returned if a unicode string is passed.
 
1901
 
 
1902
    But prior python versions failed to properly encode the passed unicode
 
1903
    string.
 
1904
    """
 
1905
    _test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
 
1906
 
 
1907
    def setUp(self):
 
1908
        super(tests.TestCaseInTempDir, self).setUp()
 
1909
        self.link = u'l\N{Euro Sign}ink'
 
1910
        self.target = u'targe\N{Euro Sign}t'
 
1911
        os.symlink(self.target, self.link)
 
1912
 
 
1913
    def test_os_readlink_link_encoding(self):
 
1914
        self.assertEquals(self.target,  os.readlink(self.link))
 
1915
 
 
1916
    def test_os_readlink_link_decoding(self):
 
1917
        self.assertEquals(self.target.encode(osutils._fs_enc),
 
1918
                          os.readlink(self.link.encode(osutils._fs_enc)))
 
1919
 
 
1920
 
 
1921
class TestConcurrency(tests.TestCase):
 
1922
 
 
1923
    def setUp(self):
 
1924
        super(TestConcurrency, self).setUp()
 
1925
        self.overrideAttr(osutils, '_cached_local_concurrency')
 
1926
 
 
1927
    def test_local_concurrency(self):
 
1928
        concurrency = osutils.local_concurrency()
 
1929
        self.assertIsInstance(concurrency, int)
 
1930
 
 
1931
    def test_local_concurrency_environment_variable(self):
 
1932
        self.overrideEnv('BZR_CONCURRENCY', '2')
 
1933
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
 
1934
        self.overrideEnv('BZR_CONCURRENCY', '3')
 
1935
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
 
1936
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
 
1937
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
 
1938
 
 
1939
    def test_option_concurrency(self):
 
1940
        self.overrideEnv('BZR_CONCURRENCY', '1')
 
1941
        self.run_bzr('rocks --concurrency 42')
 
1942
        # Command line overrides environment variable
 
1943
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
 
1944
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
 
1945
 
 
1946
 
 
1947
class TestFailedToLoadExtension(tests.TestCase):
 
1948
 
 
1949
    def _try_loading(self):
 
1950
        try:
 
1951
            import bzrlib._fictional_extension_py
 
1952
        except ImportError, e:
 
1953
            osutils.failed_to_load_extension(e)
 
1954
            return True
 
1955
 
 
1956
    def setUp(self):
 
1957
        super(TestFailedToLoadExtension, self).setUp()
 
1958
        self.overrideAttr(osutils, '_extension_load_failures', [])
 
1959
 
 
1960
    def test_failure_to_load(self):
 
1961
        self._try_loading()
 
1962
        self.assertLength(1, osutils._extension_load_failures)
 
1963
        self.assertEquals(osutils._extension_load_failures[0],
 
1964
            "No module named _fictional_extension_py")
 
1965
 
 
1966
    def test_report_extension_load_failures_no_warning(self):
 
1967
        self.assertTrue(self._try_loading())
 
1968
        warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
 
1969
        # it used to give a Python warning; it no longer does
 
1970
        self.assertLength(0, warnings)
 
1971
 
 
1972
    def test_report_extension_load_failures_message(self):
 
1973
        log = StringIO()
 
1974
        trace.push_log_file(log)
 
1975
        self.assertTrue(self._try_loading())
 
1976
        osutils.report_extension_load_failures()
 
1977
        self.assertContainsRe(
 
1978
            log.getvalue(),
 
1979
            r"bzr: warning: some compiled extensions could not be loaded; "
 
1980
            "see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
 
1981
            )
 
1982
 
 
1983
 
 
1984
class TestTerminalWidth(tests.TestCase):
 
1985
 
 
1986
    def setUp(self):
 
1987
        tests.TestCase.setUp(self)
 
1988
        self._orig_terminal_size_state = osutils._terminal_size_state
 
1989
        self._orig_first_terminal_size = osutils._first_terminal_size
 
1990
        self.addCleanup(self.restore_osutils_globals)
 
1991
        osutils._terminal_size_state = 'no_data'
 
1992
        osutils._first_terminal_size = None
 
1993
 
 
1994
    def restore_osutils_globals(self):
 
1995
        osutils._terminal_size_state = self._orig_terminal_size_state
 
1996
        osutils._first_terminal_size = self._orig_first_terminal_size
 
1997
 
 
1998
    def replace_stdout(self, new):
 
1999
        self.overrideAttr(sys, 'stdout', new)
 
2000
 
 
2001
    def replace__terminal_size(self, new):
 
2002
        self.overrideAttr(osutils, '_terminal_size', new)
 
2003
 
 
2004
    def set_fake_tty(self):
 
2005
 
 
2006
        class I_am_a_tty(object):
 
2007
            def isatty(self):
 
2008
                return True
 
2009
 
 
2010
        self.replace_stdout(I_am_a_tty())
 
2011
 
 
2012
    def test_default_values(self):
 
2013
        self.assertEqual(80, osutils.default_terminal_width)
 
2014
 
 
2015
    def test_defaults_to_BZR_COLUMNS(self):
 
2016
        # BZR_COLUMNS is set by the test framework
 
2017
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
 
2018
        self.overrideEnv('BZR_COLUMNS', '12')
 
2019
        self.assertEqual(12, osutils.terminal_width())
 
2020
 
 
2021
    def test_BZR_COLUMNS_0_no_limit(self):
 
2022
        self.overrideEnv('BZR_COLUMNS', '0')
 
2023
        self.assertEqual(None, osutils.terminal_width())
 
2024
 
 
2025
    def test_falls_back_to_COLUMNS(self):
 
2026
        self.overrideEnv('BZR_COLUMNS', None)
 
2027
        self.assertNotEqual('42', os.environ['COLUMNS'])
 
2028
        self.set_fake_tty()
 
2029
        self.overrideEnv('COLUMNS', '42')
 
2030
        self.assertEqual(42, osutils.terminal_width())
 
2031
 
 
2032
    def test_tty_default_without_columns(self):
 
2033
        self.overrideEnv('BZR_COLUMNS', None)
 
2034
        self.overrideEnv('COLUMNS', None)
 
2035
 
 
2036
        def terminal_size(w, h):
 
2037
            return 42, 42
 
2038
 
 
2039
        self.set_fake_tty()
 
2040
        # We need to override the osutils definition as it depends on the
 
2041
        # running environment that we can't control (PQM running without a
 
2042
        # controlling terminal is one example).
 
2043
        self.replace__terminal_size(terminal_size)
 
2044
        self.assertEqual(42, osutils.terminal_width())
 
2045
 
 
2046
    def test_non_tty_default_without_columns(self):
 
2047
        self.overrideEnv('BZR_COLUMNS', None)
 
2048
        self.overrideEnv('COLUMNS', None)
 
2049
        self.replace_stdout(None)
 
2050
        self.assertEqual(None, osutils.terminal_width())
 
2051
 
 
2052
    def test_no_TIOCGWINSZ(self):
 
2053
        self.requireFeature(term_ios_feature)
 
2054
        termios = term_ios_feature.module
 
2055
        # bug 63539 is about a termios without TIOCGWINSZ attribute
 
2056
        try:
 
2057
            orig = termios.TIOCGWINSZ
 
2058
        except AttributeError:
 
2059
            # We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
 
2060
            pass
 
2061
        else:
 
2062
            self.overrideAttr(termios, 'TIOCGWINSZ')
 
2063
            del termios.TIOCGWINSZ
 
2064
        self.overrideEnv('BZR_COLUMNS', None)
 
2065
        self.overrideEnv('COLUMNS', None)
 
2066
        # Whatever the result is, if we don't raise an exception, it's ok.
 
2067
        osutils.terminal_width()
 
2068
 
 
2069
 
 
2070
class TestCreationOps(tests.TestCaseInTempDir):
 
2071
    _test_needs_features = [features.chown_feature]
 
2072
 
 
2073
    def setUp(self):
 
2074
        tests.TestCaseInTempDir.setUp(self)
 
2075
        self.overrideAttr(os, 'chown', self._dummy_chown)
 
2076
 
 
2077
        # params set by call to _dummy_chown
 
2078
        self.path = self.uid = self.gid = None
 
2079
 
 
2080
    def _dummy_chown(self, path, uid, gid):
 
2081
        self.path, self.uid, self.gid = path, uid, gid
 
2082
 
 
2083
    def test_copy_ownership_from_path(self):
 
2084
        """copy_ownership_from_path test with specified src."""
 
2085
        ownsrc = '/'
 
2086
        f = open('test_file', 'wt')
 
2087
        osutils.copy_ownership_from_path('test_file', ownsrc)
 
2088
 
 
2089
        s = os.stat(ownsrc)
 
2090
        self.assertEquals(self.path, 'test_file')
 
2091
        self.assertEquals(self.uid, s.st_uid)
 
2092
        self.assertEquals(self.gid, s.st_gid)
 
2093
 
 
2094
    def test_copy_ownership_nonesrc(self):
 
2095
        """copy_ownership_from_path test with src=None."""
 
2096
        f = open('test_file', 'wt')
 
2097
        # should use parent dir for permissions
 
2098
        osutils.copy_ownership_from_path('test_file')
 
2099
 
 
2100
        s = os.stat('..')
 
2101
        self.assertEquals(self.path, 'test_file')
 
2102
        self.assertEquals(self.uid, s.st_uid)
 
2103
        self.assertEquals(self.gid, s.st_gid)
 
2104
 
 
2105
 
 
2106
class TestGetuserUnicode(tests.TestCase):
 
2107
 
 
2108
    def test_ascii_user(self):
 
2109
        self.overrideEnv('LOGNAME', 'jrandom')
 
2110
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
 
2111
 
 
2112
    def test_unicode_user(self):
 
2113
        ue = osutils.get_user_encoding()
 
2114
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
2115
        if uni_val is None:
 
2116
            raise tests.TestSkipped(
 
2117
                'Cannot find a unicode character that works in encoding %s'
 
2118
                % (osutils.get_user_encoding(),))
 
2119
        uni_username = u'jrandom' + uni_val
 
2120
        encoded_username = uni_username.encode(ue)
 
2121
        self.overrideEnv('LOGNAME', encoded_username)
 
2122
        self.assertEqual(uni_username, osutils.getuser_unicode())
 
2123
        self.overrideEnv('LOGNAME', u'jrandom\xb6'.encode(ue))
 
2124
        self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
 
2125
 
 
2126
    def test_no_username_bug_660174(self):
 
2127
        self.requireFeature(features.win32_feature)
 
2128
        for name in ('LOGNAME', 'USER', 'LNAME', 'USERNAME'):
 
2129
            self.overrideEnv(name, None)
 
2130
        self.assertEqual(u'UNKNOWN', osutils.getuser_unicode())
 
2131
 
 
2132
 
 
2133
class TestBackupNames(tests.TestCase):
 
2134
 
 
2135
    def setUp(self):
 
2136
        super(TestBackupNames, self).setUp()
 
2137
        self.backups = []
 
2138
 
 
2139
    def backup_exists(self, name):
 
2140
        return name in self.backups
 
2141
 
 
2142
    def available_backup_name(self, name):
 
2143
        backup_name = osutils.available_backup_name(name, self.backup_exists)
 
2144
        self.backups.append(backup_name)
 
2145
        return backup_name
 
2146
 
 
2147
    def assertBackupName(self, expected, name):
 
2148
        self.assertEqual(expected, self.available_backup_name(name))
 
2149
 
 
2150
    def test_empty(self):
 
2151
        self.assertBackupName('file.~1~', 'file')
 
2152
 
 
2153
    def test_existing(self):
 
2154
        self.available_backup_name('file')
 
2155
        self.available_backup_name('file')
 
2156
        self.assertBackupName('file.~3~', 'file')
 
2157
        # Empty slots are found, this is not a strict requirement and may be
 
2158
        # revisited if we test against all implementations.
 
2159
        self.backups.remove('file.~2~')
 
2160
        self.assertBackupName('file.~2~', 'file')
 
2161
 
 
2162
 
 
2163
class TestFindExecutableInPath(tests.TestCase):
 
2164
 
 
2165
    def test_windows(self):
 
2166
        if sys.platform != 'win32':
 
2167
            raise tests.TestSkipped('test requires win32')
 
2168
        self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
 
2169
        self.assertTrue(
 
2170
            osutils.find_executable_on_path('explorer.exe') is not None)
 
2171
        self.assertTrue(
 
2172
            osutils.find_executable_on_path('EXPLORER.EXE') is not None)
 
2173
        self.assertTrue(
 
2174
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2175
        self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
 
2176
 
 
2177
    def test_other(self):
 
2178
        if sys.platform == 'win32':
 
2179
            raise tests.TestSkipped('test requires non-win32')
 
2180
        self.assertTrue(osutils.find_executable_on_path('sh') is not None)
 
2181
        self.assertTrue(
 
2182
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2183
 
 
2184
 
 
2185
class TestEnvironmentErrors(tests.TestCase):
 
2186
    """Test handling of environmental errors"""
 
2187
 
 
2188
    def test_is_oserror(self):
 
2189
        self.assertTrue(osutils.is_environment_error(
 
2190
            OSError(errno.EINVAL, "Invalid parameter")))
 
2191
 
 
2192
    def test_is_ioerror(self):
 
2193
        self.assertTrue(osutils.is_environment_error(
 
2194
            IOError(errno.EINVAL, "Invalid parameter")))
 
2195
 
 
2196
    def test_is_socket_error(self):
 
2197
        self.assertTrue(osutils.is_environment_error(
 
2198
            socket.error(errno.EINVAL, "Invalid parameter")))
 
2199
 
 
2200
    def test_is_select_error(self):
 
2201
        self.assertTrue(osutils.is_environment_error(
 
2202
            select.error(errno.EINVAL, "Invalid parameter")))
 
2203
 
 
2204
    def test_is_pywintypes_error(self):
 
2205
        self.requireFeature(features.pywintypes)
 
2206
        import pywintypes
 
2207
        self.assertTrue(osutils.is_environment_error(
 
2208
            pywintypes.error(errno.EINVAL, "Invalid parameter", "Caller")))