← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2011-10-14 13:56:45 UTC
  • mfrom: (6215 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20111014135645-phc3q3y21k2ks0s2
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_osutils.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
21
21
import os
22
22
import re
23
23
import socket
24
 
import stat
25
24
import sys
26
25
import time
27
26
 
28
27
from bzrlib import (
29
28
    errors,
 
29
    lazy_regex,
30
30
    osutils,
 
31
    symbol_versioning,
31
32
    tests,
 
33
    trace,
32
34
    win32utils,
33
35
    )
34
36
from bzrlib.tests import (
 
37
    features,
35
38
    file_utils,
36
39
    test__walkdirs_win32,
37
40
    )
38
 
 
39
 
 
40
 
class _UTF8DirReaderFeature(tests.Feature):
 
41
from bzrlib.tests.scenarios import load_tests_apply_scenarios
 
42
 
 
43
 
 
44
class _UTF8DirReaderFeature(features.Feature):
41
45
 
42
46
    def _probe(self):
43
47
        try:
50
54
    def feature_name(self):
51
55
        return 'bzrlib._readdir_pyx'
52
56
 
53
 
UTF8DirReaderFeature = _UTF8DirReaderFeature()
 
57
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
 
58
 
 
59
term_ios_feature = features.ModuleAvailableFeature('termios')
54
60
 
55
61
 
56
62
def _already_unicode(s):
57
63
    return s
58
64
 
59
65
 
60
 
def _fs_enc_to_unicode(s):
61
 
    return s.decode(osutils._fs_enc)
62
 
 
63
 
 
64
66
def _utf8_to_unicode(s):
65
67
    return s.decode('UTF-8')
66
68
 
83
85
                          dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
84
86
                               _native_to_unicode=_utf8_to_unicode)))
85
87
 
86
 
    if test__walkdirs_win32.Win32ReadDirFeature.available():
 
88
    if test__walkdirs_win32.win32_readdir_feature.available():
87
89
        try:
88
90
            from bzrlib import _walkdirs_win32
89
 
            # TODO: check on windows, it may be that we need to use/add
90
 
            # safe_unicode instead of _fs_enc_to_unicode
91
91
            scenarios.append(
92
92
                ('win32',
93
93
                 dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
94
 
                      _native_to_unicode=_fs_enc_to_unicode)))
 
94
                      _native_to_unicode=_already_unicode)))
95
95
        except ImportError:
96
96
            pass
97
97
    return scenarios
98
98
 
99
99
 
100
 
def load_tests(basic_tests, module, loader):
101
 
    suite = loader.suiteClass()
102
 
    dir_reader_tests, remaining_tests = tests.split_suite_by_condition(
103
 
        basic_tests, tests.condition_isinstance(TestDirReader))
104
 
    tests.multiply_tests(dir_reader_tests, dir_reader_scenarios(), suite)
105
 
    suite.addTest(remaining_tests)
106
 
    return suite
 
100
load_tests = load_tests_apply_scenarios
107
101
 
108
102
 
109
103
class TestContainsWhitespace(tests.TestCase):
110
104
 
111
105
    def test_contains_whitespace(self):
112
 
        self.failUnless(osutils.contains_whitespace(u' '))
113
 
        self.failUnless(osutils.contains_whitespace(u'hello there'))
114
 
        self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
115
 
        self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
116
 
        self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
117
 
        self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
 
106
        self.assertTrue(osutils.contains_whitespace(u' '))
 
107
        self.assertTrue(osutils.contains_whitespace(u'hello there'))
 
108
        self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
 
109
        self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
 
110
        self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
 
111
        self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
118
112
 
119
113
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
120
114
        # is whitespace, but we do not.
121
 
        self.failIf(osutils.contains_whitespace(u''))
122
 
        self.failIf(osutils.contains_whitespace(u'hellothere'))
123
 
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
 
115
        self.assertFalse(osutils.contains_whitespace(u''))
 
116
        self.assertFalse(osutils.contains_whitespace(u'hellothere'))
 
117
        self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
124
118
 
125
119
 
126
120
class TestRename(tests.TestCaseInTempDir):
127
121
 
 
122
    def create_file(self, filename, content):
 
123
        f = open(filename, 'wb')
 
124
        try:
 
125
            f.write(content)
 
126
        finally:
 
127
            f.close()
 
128
 
 
129
    def _fancy_rename(self, a, b):
 
130
        osutils.fancy_rename(a, b, rename_func=os.rename,
 
131
                             unlink_func=os.unlink)
 
132
 
128
133
    def test_fancy_rename(self):
129
134
        # This should work everywhere
130
 
        def rename(a, b):
131
 
            osutils.fancy_rename(a, b,
132
 
                    rename_func=os.rename,
133
 
                    unlink_func=os.unlink)
134
 
 
135
 
        open('a', 'wb').write('something in a\n')
136
 
        rename('a', 'b')
137
 
        self.failIfExists('a')
138
 
        self.failUnlessExists('b')
 
135
        self.create_file('a', 'something in a\n')
 
136
        self._fancy_rename('a', 'b')
 
137
        self.assertPathDoesNotExist('a')
 
138
        self.assertPathExists('b')
139
139
        self.check_file_contents('b', 'something in a\n')
140
140
 
141
 
        open('a', 'wb').write('new something in a\n')
142
 
        rename('b', 'a')
 
141
        self.create_file('a', 'new something in a\n')
 
142
        self._fancy_rename('b', 'a')
143
143
 
144
144
        self.check_file_contents('a', 'something in a\n')
145
145
 
 
146
    def test_fancy_rename_fails_source_missing(self):
 
147
        # An exception should be raised, and the target should be left in place
 
148
        self.create_file('target', 'data in target\n')
 
149
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
150
                          'missingsource', 'target')
 
151
        self.assertPathExists('target')
 
152
        self.check_file_contents('target', 'data in target\n')
 
153
 
 
154
    def test_fancy_rename_fails_if_source_and_target_missing(self):
 
155
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
156
                          'missingsource', 'missingtarget')
 
157
 
146
158
    def test_rename(self):
147
159
        # Rename should be semi-atomic on all platforms
148
 
        open('a', 'wb').write('something in a\n')
 
160
        self.create_file('a', 'something in a\n')
149
161
        osutils.rename('a', 'b')
150
 
        self.failIfExists('a')
151
 
        self.failUnlessExists('b')
 
162
        self.assertPathDoesNotExist('a')
 
163
        self.assertPathExists('b')
152
164
        self.check_file_contents('b', 'something in a\n')
153
165
 
154
 
        open('a', 'wb').write('new something in a\n')
 
166
        self.create_file('a', 'new something in a\n')
155
167
        osutils.rename('b', 'a')
156
168
 
157
169
        self.check_file_contents('a', 'something in a\n')
219
231
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
220
232
 
221
233
 
 
234
class TestLstat(tests.TestCaseInTempDir):
 
235
 
 
236
    def test_lstat_matches_fstat(self):
 
237
        # On Windows, lstat and fstat don't always agree, primarily in the
 
238
        # 'st_ino' and 'st_dev' fields. So we force them to be '0' in our
 
239
        # custom implementation.
 
240
        if sys.platform == 'win32':
 
241
            # We only have special lstat/fstat if we have the extension.
 
242
            # Without it, we may end up re-reading content when we don't have
 
243
            # to, but otherwise it doesn't effect correctness.
 
244
            self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
245
        f = open('test-file.txt', 'wb')
 
246
        self.addCleanup(f.close)
 
247
        f.write('some content\n')
 
248
        f.flush()
 
249
        self.assertEqualStat(osutils.fstat(f.fileno()),
 
250
                             osutils.lstat('test-file.txt'))
 
251
 
 
252
 
222
253
class TestRmTree(tests.TestCaseInTempDir):
223
254
 
224
255
    def test_rmtree(self):
236
267
 
237
268
        osutils.rmtree('dir')
238
269
 
239
 
        self.failIfExists('dir/file')
240
 
        self.failIfExists('dir')
 
270
        self.assertPathDoesNotExist('dir/file')
 
271
        self.assertPathDoesNotExist('dir')
241
272
 
242
273
 
243
274
class TestDeleteAny(tests.TestCaseInTempDir):
294
325
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
295
326
        self.assertEqual("@", osutils.kind_marker("symlink"))
296
327
        self.assertEqual("+", osutils.kind_marker("tree-reference"))
297
 
        self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
 
328
        self.assertEqual("", osutils.kind_marker("fifo"))
 
329
        self.assertEqual("", osutils.kind_marker("socket"))
 
330
        self.assertEqual("", osutils.kind_marker("unknown"))
298
331
 
299
332
 
300
333
class TestUmask(tests.TestCaseInTempDir):
365
398
        # Instead blackbox.test_locale should check for localized
366
399
        # dates once they do occur in output strings.
367
400
 
 
401
    def test_format_date_with_offset_in_original_timezone(self):
 
402
        self.assertEqual("Thu 1970-01-01 00:00:00 +0000",
 
403
            osutils.format_date_with_offset_in_original_timezone(0))
 
404
        self.assertEqual("Fri 1970-01-02 03:46:40 +0000",
 
405
            osutils.format_date_with_offset_in_original_timezone(100000))
 
406
        self.assertEqual("Fri 1970-01-02 05:46:40 +0200",
 
407
            osutils.format_date_with_offset_in_original_timezone(100000, 7200))
 
408
 
368
409
    def test_local_time_offset(self):
369
410
        """Test that local_time_offset() returns a sane value."""
370
411
        offset = osutils.local_time_offset()
388
429
class TestLinks(tests.TestCaseInTempDir):
389
430
 
390
431
    def test_dereference_path(self):
391
 
        self.requireFeature(tests.SymlinkFeature)
 
432
        self.requireFeature(features.SymlinkFeature)
392
433
        cwd = osutils.realpath('.')
393
434
        os.mkdir('bar')
394
435
        bar_path = osutils.pathjoin(cwd, 'bar')
441
482
 
442
483
class TestCanonicalRelPath(tests.TestCaseInTempDir):
443
484
 
444
 
    _test_needs_features = [tests.CaseInsCasePresFilenameFeature]
 
485
    _test_needs_features = [features.CaseInsCasePresFilenameFeature]
445
486
 
446
487
    def test_canonical_relpath_simple(self):
447
488
        f = file('MixedCaseName', 'w')
448
489
        f.close()
449
 
        # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
450
 
        real_base_dir = osutils.realpath(self.test_base_dir)
451
 
        actual = osutils.canonical_relpath(real_base_dir, 'mixedcasename')
452
 
        self.failUnlessEqual('work/MixedCaseName', actual)
 
490
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
 
491
        self.assertEqual('work/MixedCaseName', actual)
453
492
 
454
493
    def test_canonical_relpath_missing_tail(self):
455
494
        os.mkdir('MixedCaseParent')
456
 
        # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
457
 
        real_base_dir = osutils.realpath(self.test_base_dir)
458
 
        actual = osutils.canonical_relpath(real_base_dir,
 
495
        actual = osutils.canonical_relpath(self.test_base_dir,
459
496
                                           'mixedcaseparent/nochild')
460
 
        self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
 
497
        self.assertEqual('work/MixedCaseParent/nochild', actual)
 
498
 
 
499
 
 
500
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
 
501
 
 
502
    def assertRelpath(self, expected, base, path):
 
503
        actual = osutils._cicp_canonical_relpath(base, path)
 
504
        self.assertEqual(expected, actual)
 
505
 
 
506
    def test_simple(self):
 
507
        self.build_tree(['MixedCaseName'])
 
508
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
509
        self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
 
510
 
 
511
    def test_subdir_missing_tail(self):
 
512
        self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
 
513
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
514
        self.assertRelpath('MixedCaseParent/a_child', base,
 
515
                           'MixedCaseParent/a_child')
 
516
        self.assertRelpath('MixedCaseParent/a_child', base,
 
517
                           'MixedCaseParent/A_Child')
 
518
        self.assertRelpath('MixedCaseParent/not_child', base,
 
519
                           'MixedCaseParent/not_child')
 
520
 
 
521
    def test_at_root_slash(self):
 
522
        # We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
 
523
        # check...
 
524
        if osutils.MIN_ABS_PATHLENGTH > 1:
 
525
            raise tests.TestSkipped('relpath requires %d chars'
 
526
                                    % osutils.MIN_ABS_PATHLENGTH)
 
527
        self.assertRelpath('foo', '/', '/foo')
 
528
 
 
529
    def test_at_root_drive(self):
 
530
        if sys.platform != 'win32':
 
531
            raise tests.TestNotApplicable('we can only test drive-letter relative'
 
532
                                          ' paths on Windows where we have drive'
 
533
                                          ' letters.')
 
534
        # see bug #322807
 
535
        # The specific issue is that when at the root of a drive, 'abspath'
 
536
        # returns "C:/" or just "/". However, the code assumes that abspath
 
537
        # always returns something like "C:/foo" or "/foo" (no trailing slash).
 
538
        self.assertRelpath('foo', 'C:/', 'C:/foo')
 
539
        self.assertRelpath('foo', 'X:/', 'X:/foo')
 
540
        self.assertRelpath('foo', 'X:/', 'X://foo')
461
541
 
462
542
 
463
543
class TestPumpFile(tests.TestCase):
738
818
        self.assertEqual(None, osutils.safe_file_id(None))
739
819
 
740
820
 
 
821
class TestPosixFuncs(tests.TestCase):
 
822
    """Test that the posix version of normpath returns an appropriate path
 
823
       when used with 2 leading slashes."""
 
824
 
 
825
    def test_normpath(self):
 
826
        self.assertEqual('/etc/shadow', osutils._posix_normpath('/etc/shadow'))
 
827
        self.assertEqual('/etc/shadow', osutils._posix_normpath('//etc/shadow'))
 
828
        self.assertEqual('/etc/shadow', osutils._posix_normpath('///etc/shadow'))
 
829
 
 
830
 
741
831
class TestWin32Funcs(tests.TestCase):
742
832
    """Test that _win32 versions of os utilities return appropriate paths."""
743
833
 
796
886
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
797
887
        # relative path
798
888
        cwd = osutils.getcwd().rstrip('/')
799
 
        drive = osutils._nt_splitdrive(cwd)[0]
 
889
        drive = osutils.ntpath.splitdrive(cwd)[0]
800
890
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
801
891
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
802
892
        # unicode path
808
898
    """Test win32 functions that create files."""
809
899
 
810
900
    def test_getcwd(self):
811
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
901
        self.requireFeature(features.UnicodeFilenameFeature)
812
902
        os.mkdir(u'mu-\xb5')
813
903
        os.chdir(u'mu-\xb5')
814
904
        # TODO: jam 20060427 This will probably fail on Mac OSX because
844
934
        b.close()
845
935
 
846
936
        osutils._win32_rename('b', 'a')
847
 
        self.failUnlessExists('a')
848
 
        self.failIfExists('b')
 
937
        self.assertPathExists('a')
 
938
        self.assertPathDoesNotExist('b')
849
939
        self.assertFileEqual('baz\n', 'a')
850
940
 
851
941
    def test_rename_missing_file(self):
904
994
    """Test mac special functions that require directories."""
905
995
 
906
996
    def test_getcwd(self):
907
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
997
        self.requireFeature(features.UnicodeFilenameFeature)
908
998
        os.mkdir(u'B\xe5gfors')
909
999
        os.chdir(u'B\xe5gfors')
910
1000
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
911
1001
 
912
1002
    def test_getcwd_nonnorm(self):
913
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1003
        self.requireFeature(features.UnicodeFilenameFeature)
914
1004
        # Test that _mac_getcwd() will normalize this path
915
1005
        os.mkdir(u'Ba\u030agfors')
916
1006
        os.chdir(u'Ba\u030agfors')
927
1017
 
928
1018
    def test_osutils_binding(self):
929
1019
        from bzrlib.tests import test__chunks_to_lines
930
 
        if test__chunks_to_lines.CompiledChunksToLinesFeature.available():
 
1020
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
931
1021
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
932
1022
        else:
933
1023
            from bzrlib._chunks_to_lines_py import chunks_to_lines
999
1089
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
1000
1090
 
1001
1091
    def test_walkdirs_os_error(self):
1002
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/338653>
 
1092
        # <https://bugs.launchpad.net/bzr/+bug/338653>
1003
1093
        # Pyrex readdir didn't raise useful messages if it had an error
1004
1094
        # reading the directory
1005
1095
        if sys.platform == 'win32':
1006
1096
            raise tests.TestNotApplicable(
1007
1097
                "readdir IOError not tested on win32")
 
1098
        self.requireFeature(features.not_running_as_root)
1008
1099
        os.mkdir("test-unreadable")
1009
1100
        os.chmod("test-unreadable", 0000)
1010
1101
        # must chmod it back so that it can be removed
1018
1109
        # Ensure the message contains the file name
1019
1110
        self.assertContainsRe(str(e), "\./test-unreadable")
1020
1111
 
 
1112
 
 
1113
    def test_walkdirs_encoding_error(self):
 
1114
        # <https://bugs.launchpad.net/bzr/+bug/488519>
 
1115
        # walkdirs didn't raise a useful message when the filenames
 
1116
        # are not using the filesystem's encoding
 
1117
 
 
1118
        # require a bytestring based filesystem
 
1119
        self.requireFeature(features.ByteStringNamedFilesystem)
 
1120
 
 
1121
        tree = [
 
1122
            '.bzr',
 
1123
            '0file',
 
1124
            '1dir/',
 
1125
            '1dir/0file',
 
1126
            '1dir/1dir/',
 
1127
            '1file'
 
1128
            ]
 
1129
 
 
1130
        self.build_tree(tree)
 
1131
 
 
1132
        # rename the 1file to a latin-1 filename
 
1133
        os.rename("./1file", "\xe8file")
 
1134
        if "\xe8file" not in os.listdir("."):
 
1135
            self.skip("Lack filesystem that preserves arbitrary bytes")
 
1136
 
 
1137
        self._save_platform_info()
 
1138
        win32utils.winver = None # Avoid the win32 detection code
 
1139
        osutils._fs_enc = 'UTF-8'
 
1140
 
 
1141
        # this should raise on error
 
1142
        def attempt():
 
1143
            for dirdetail, dirblock in osutils.walkdirs('.'):
 
1144
                pass
 
1145
 
 
1146
        self.assertRaises(errors.BadFilenameEncoding, attempt)
 
1147
 
1021
1148
    def test__walkdirs_utf8(self):
1022
1149
        tree = [
1023
1150
            '.bzr',
1073
1200
            dirblock[:] = new_dirblock
1074
1201
 
1075
1202
    def _save_platform_info(self):
1076
 
        cur_winver = win32utils.winver
1077
 
        cur_fs_enc = osutils._fs_enc
1078
 
        cur_dir_reader = osutils._selected_dir_reader
1079
 
        def restore():
1080
 
            win32utils.winver = cur_winver
1081
 
            osutils._fs_enc = cur_fs_enc
1082
 
            osutils._selected_dir_reader = cur_dir_reader
1083
 
        self.addCleanup(restore)
 
1203
        self.overrideAttr(win32utils, 'winver')
 
1204
        self.overrideAttr(osutils, '_fs_enc')
 
1205
        self.overrideAttr(osutils, '_selected_dir_reader')
1084
1206
 
1085
1207
    def assertDirReaderIs(self, expected):
1086
1208
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
1095
1217
        self._save_platform_info()
1096
1218
        win32utils.winver = None # Avoid the win32 detection code
1097
1219
        osutils._fs_enc = 'UTF-8'
1098
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1220
        self.assertDirReaderIs(
 
1221
            UTF8DirReaderFeature.module.UTF8DirReader)
1099
1222
 
1100
1223
    def test_force_walkdirs_utf8_fs_ascii(self):
1101
1224
        self.requireFeature(UTF8DirReaderFeature)
1102
1225
        self._save_platform_info()
1103
1226
        win32utils.winver = None # Avoid the win32 detection code
1104
1227
        osutils._fs_enc = 'US-ASCII'
1105
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1228
        self.assertDirReaderIs(
 
1229
            UTF8DirReaderFeature.module.UTF8DirReader)
1106
1230
 
1107
1231
    def test_force_walkdirs_utf8_fs_ANSI(self):
1108
1232
        self.requireFeature(UTF8DirReaderFeature)
1109
1233
        self._save_platform_info()
1110
1234
        win32utils.winver = None # Avoid the win32 detection code
1111
1235
        osutils._fs_enc = 'ANSI_X3.4-1968'
1112
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1236
        self.assertDirReaderIs(
 
1237
            UTF8DirReaderFeature.module.UTF8DirReader)
1113
1238
 
1114
1239
    def test_force_walkdirs_utf8_fs_latin1(self):
1115
1240
        self._save_platform_info()
1119
1244
 
1120
1245
    def test_force_walkdirs_utf8_nt(self):
1121
1246
        # Disabled because the thunk of the whole walkdirs api is disabled.
1122
 
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1247
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1123
1248
        self._save_platform_info()
1124
1249
        win32utils.winver = 'Windows NT'
1125
1250
        from bzrlib._walkdirs_win32 import Win32ReadDir
1126
1251
        self.assertDirReaderIs(Win32ReadDir)
1127
1252
 
1128
1253
    def test_force_walkdirs_utf8_98(self):
1129
 
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1254
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1130
1255
        self._save_platform_info()
1131
1256
        win32utils.winver = 'Windows 98'
1132
1257
        self.assertDirReaderIs(osutils.UnicodeDirReader)
1133
1258
 
1134
1259
    def test_unicode_walkdirs(self):
1135
1260
        """Walkdirs should always return unicode paths."""
1136
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1261
        self.requireFeature(features.UnicodeFilenameFeature)
1137
1262
        name0 = u'0file-\xb6'
1138
1263
        name1 = u'1dir-\u062c\u0648'
1139
1264
        name2 = u'2file-\u0633'
1176
1301
 
1177
1302
        The abspath portion might be in unicode or utf-8
1178
1303
        """
1179
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1304
        self.requireFeature(features.UnicodeFilenameFeature)
1180
1305
        name0 = u'0file-\xb6'
1181
1306
        name1 = u'1dir-\u062c\u0648'
1182
1307
        name2 = u'2file-\u0633'
1237
1362
 
1238
1363
        The abspath portion should be in unicode
1239
1364
        """
1240
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1365
        self.requireFeature(features.UnicodeFilenameFeature)
1241
1366
        # Use the unicode reader. TODO: split into driver-and-driven unit
1242
1367
        # tests.
1243
1368
        self._save_platform_info()
1283
1408
        self.assertEqual(expected_dirblocks, result)
1284
1409
 
1285
1410
    def test__walkdirs_utf8_win32readdir(self):
1286
 
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
1287
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1411
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1412
        self.requireFeature(features.UnicodeFilenameFeature)
1288
1413
        from bzrlib._walkdirs_win32 import Win32ReadDir
1289
1414
        self._save_platform_info()
1290
1415
        osutils._selected_dir_reader = Win32ReadDir()
1340
1465
 
1341
1466
    def test__walkdirs_utf_win32_find_file_stat_file(self):
1342
1467
        """make sure our Stat values are valid"""
1343
 
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
1344
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1468
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1469
        self.requireFeature(features.UnicodeFilenameFeature)
1345
1470
        from bzrlib._walkdirs_win32 import Win32ReadDir
1346
1471
        name0u = u'0file-\xb6'
1347
1472
        name0 = name0u.encode('utf8')
1364
1489
 
1365
1490
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
1366
1491
        """make sure our Stat values are valid"""
1367
 
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
1368
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1492
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1493
        self.requireFeature(features.UnicodeFilenameFeature)
1369
1494
        from bzrlib._walkdirs_win32 import Win32ReadDir
1370
1495
        name0u = u'0dir-\u062c\u0648'
1371
1496
        name0 = name0u.encode('utf8')
1471
1596
        self.assertEqual(['c'], os.listdir('target/b'))
1472
1597
 
1473
1598
    def test_copy_tree_symlinks(self):
1474
 
        self.requireFeature(tests.SymlinkFeature)
 
1599
        self.requireFeature(features.SymlinkFeature)
1475
1600
        self.build_tree(['source/'])
1476
1601
        os.symlink('a/generic/path', 'source/lnk')
1477
1602
        osutils.copy_tree('source', 'target')
1502
1627
                          ('d', 'source/b', 'target/b'),
1503
1628
                          ('f', 'source/b/c', 'target/b/c'),
1504
1629
                         ], processed_files)
1505
 
        self.failIfExists('target')
 
1630
        self.assertPathDoesNotExist('target')
1506
1631
        if osutils.has_symlinks():
1507
1632
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1508
1633
 
1519
1644
        def cleanup():
1520
1645
            if 'BZR_TEST_ENV_VAR' in os.environ:
1521
1646
                del os.environ['BZR_TEST_ENV_VAR']
1522
 
 
1523
1647
        self.addCleanup(cleanup)
1524
1648
 
1525
1649
    def test_set(self):
1555
1679
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1556
1680
        self.assertEqual('foo', old)
1557
1681
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1558
 
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
 
1682
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1559
1683
 
1560
1684
 
1561
1685
class TestSizeShaFile(tests.TestCaseInTempDir):
1573
1697
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
1574
1698
        self.build_tree_contents([('foo', text)])
1575
1699
        expected_sha = osutils.sha_string(text)
1576
 
        f = open('foo')
 
1700
        f = open('foo', 'rb')
1577
1701
        self.addCleanup(f.close)
1578
1702
        size, sha = osutils.size_sha_file(f)
1579
1703
        self.assertEqual(38, size)
1612
1736
 
1613
1737
class TestReCompile(tests.TestCase):
1614
1738
 
 
1739
    def _deprecated_re_compile_checked(self, *args, **kwargs):
 
1740
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
 
1741
            osutils.re_compile_checked, *args, **kwargs)
 
1742
 
1615
1743
    def test_re_compile_checked(self):
1616
 
        r = osutils.re_compile_checked(r'A*', re.IGNORECASE)
 
1744
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1617
1745
        self.assertTrue(r.match('aaaa'))
1618
1746
        self.assertTrue(r.match('aAaA'))
1619
1747
 
1620
1748
    def test_re_compile_checked_error(self):
1621
1749
        # like https://bugs.launchpad.net/bzr/+bug/251352
 
1750
 
 
1751
        # Due to possible test isolation error, re.compile is not lazy at
 
1752
        # this point. We re-install lazy compile.
 
1753
        lazy_regex.install_lazy_compile()
1622
1754
        err = self.assertRaises(
1623
1755
            errors.BzrCommandError,
1624
 
            osutils.re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1756
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1625
1757
        self.assertEqual(
1626
 
            "Invalid regular expression in test case: '*': "
1627
 
            "nothing to repeat",
 
1758
            'Invalid regular expression in test case: '
 
1759
            '"*" nothing to repeat',
1628
1760
            str(err))
1629
1761
 
1630
1762
 
1631
1763
class TestDirReader(tests.TestCaseInTempDir):
1632
1764
 
 
1765
    scenarios = dir_reader_scenarios()
 
1766
 
1633
1767
    # Set by load_tests
1634
1768
    _dir_reader_class = None
1635
1769
    _native_to_unicode = None
1636
1770
 
1637
1771
    def setUp(self):
1638
1772
        tests.TestCaseInTempDir.setUp(self)
1639
 
 
1640
 
        # Save platform specific info and reset it
1641
 
        cur_dir_reader = osutils._selected_dir_reader
1642
 
 
1643
 
        def restore():
1644
 
            osutils._selected_dir_reader = cur_dir_reader
1645
 
        self.addCleanup(restore)
1646
 
 
1647
 
        osutils._selected_dir_reader = self._dir_reader_class()
 
1773
        self.overrideAttr(osutils,
 
1774
                          '_selected_dir_reader', self._dir_reader_class())
1648
1775
 
1649
1776
    def _get_ascii_tree(self):
1650
1777
        tree = [
1742
1869
        return filtered_dirblocks
1743
1870
 
1744
1871
    def test_walk_unicode_tree(self):
1745
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1872
        self.requireFeature(features.UnicodeFilenameFeature)
1746
1873
        tree, expected_dirblocks = self._get_unicode_tree()
1747
1874
        self.build_tree(tree)
1748
1875
        result = list(osutils._walkdirs_utf8('.'))
1749
1876
        self.assertEqual(expected_dirblocks, self._filter_out(result))
1750
1877
 
1751
1878
    def test_symlink(self):
1752
 
        self.requireFeature(tests.SymlinkFeature)
1753
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1879
        self.requireFeature(features.SymlinkFeature)
 
1880
        self.requireFeature(features.UnicodeFilenameFeature)
1754
1881
        target = u'target\N{Euro Sign}'
1755
1882
        link_name = u'l\N{Euro Sign}nk'
1756
1883
        os.symlink(target, link_name)
1774
1901
    But prior python versions failed to properly encode the passed unicode
1775
1902
    string.
1776
1903
    """
1777
 
    _test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
 
1904
    _test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
1778
1905
 
1779
1906
    def setUp(self):
1780
1907
        super(tests.TestCaseInTempDir, self).setUp()
1783
1910
        os.symlink(self.target, self.link)
1784
1911
 
1785
1912
    def test_os_readlink_link_encoding(self):
1786
 
        if sys.version_info < (2, 6):
1787
 
            self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
1788
 
        else:
1789
 
            self.assertEquals(self.target,  os.readlink(self.link))
 
1913
        self.assertEquals(self.target,  os.readlink(self.link))
1790
1914
 
1791
1915
    def test_os_readlink_link_decoding(self):
1792
1916
        self.assertEquals(self.target.encode(osutils._fs_enc),
1795
1919
 
1796
1920
class TestConcurrency(tests.TestCase):
1797
1921
 
 
1922
    def setUp(self):
 
1923
        super(TestConcurrency, self).setUp()
 
1924
        self.overrideAttr(osutils, '_cached_local_concurrency')
 
1925
 
1798
1926
    def test_local_concurrency(self):
1799
1927
        concurrency = osutils.local_concurrency()
1800
1928
        self.assertIsInstance(concurrency, int)
 
1929
 
 
1930
    def test_local_concurrency_environment_variable(self):
 
1931
        self.overrideEnv('BZR_CONCURRENCY', '2')
 
1932
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
 
1933
        self.overrideEnv('BZR_CONCURRENCY', '3')
 
1934
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
 
1935
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
 
1936
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
 
1937
 
 
1938
    def test_option_concurrency(self):
 
1939
        self.overrideEnv('BZR_CONCURRENCY', '1')
 
1940
        self.run_bzr('rocks --concurrency 42')
 
1941
        # Command line overrides environment variable
 
1942
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
 
1943
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
 
1944
 
 
1945
 
 
1946
class TestFailedToLoadExtension(tests.TestCase):
 
1947
 
 
1948
    def _try_loading(self):
 
1949
        try:
 
1950
            import bzrlib._fictional_extension_py
 
1951
        except ImportError, e:
 
1952
            osutils.failed_to_load_extension(e)
 
1953
            return True
 
1954
 
 
1955
    def setUp(self):
 
1956
        super(TestFailedToLoadExtension, self).setUp()
 
1957
        self.overrideAttr(osutils, '_extension_load_failures', [])
 
1958
 
 
1959
    def test_failure_to_load(self):
 
1960
        self._try_loading()
 
1961
        self.assertLength(1, osutils._extension_load_failures)
 
1962
        self.assertEquals(osutils._extension_load_failures[0],
 
1963
            "No module named _fictional_extension_py")
 
1964
 
 
1965
    def test_report_extension_load_failures_no_warning(self):
 
1966
        self.assertTrue(self._try_loading())
 
1967
        warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
 
1968
        # it used to give a Python warning; it no longer does
 
1969
        self.assertLength(0, warnings)
 
1970
 
 
1971
    def test_report_extension_load_failures_message(self):
 
1972
        log = StringIO()
 
1973
        trace.push_log_file(log)
 
1974
        self.assertTrue(self._try_loading())
 
1975
        osutils.report_extension_load_failures()
 
1976
        self.assertContainsRe(
 
1977
            log.getvalue(),
 
1978
            r"bzr: warning: some compiled extensions could not be loaded; "
 
1979
            "see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
 
1980
            )
 
1981
 
 
1982
 
 
1983
class TestTerminalWidth(tests.TestCase):
 
1984
 
 
1985
    def setUp(self):
 
1986
        tests.TestCase.setUp(self)
 
1987
        self._orig_terminal_size_state = osutils._terminal_size_state
 
1988
        self._orig_first_terminal_size = osutils._first_terminal_size
 
1989
        self.addCleanup(self.restore_osutils_globals)
 
1990
        osutils._terminal_size_state = 'no_data'
 
1991
        osutils._first_terminal_size = None
 
1992
 
 
1993
    def restore_osutils_globals(self):
 
1994
        osutils._terminal_size_state = self._orig_terminal_size_state
 
1995
        osutils._first_terminal_size = self._orig_first_terminal_size
 
1996
 
 
1997
    def replace_stdout(self, new):
 
1998
        self.overrideAttr(sys, 'stdout', new)
 
1999
 
 
2000
    def replace__terminal_size(self, new):
 
2001
        self.overrideAttr(osutils, '_terminal_size', new)
 
2002
 
 
2003
    def set_fake_tty(self):
 
2004
 
 
2005
        class I_am_a_tty(object):
 
2006
            def isatty(self):
 
2007
                return True
 
2008
 
 
2009
        self.replace_stdout(I_am_a_tty())
 
2010
 
 
2011
    def test_default_values(self):
 
2012
        self.assertEqual(80, osutils.default_terminal_width)
 
2013
 
 
2014
    def test_defaults_to_BZR_COLUMNS(self):
 
2015
        # BZR_COLUMNS is set by the test framework
 
2016
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
 
2017
        self.overrideEnv('BZR_COLUMNS', '12')
 
2018
        self.assertEqual(12, osutils.terminal_width())
 
2019
 
 
2020
    def test_BZR_COLUMNS_0_no_limit(self):
 
2021
        self.overrideEnv('BZR_COLUMNS', '0')
 
2022
        self.assertEqual(None, osutils.terminal_width())
 
2023
 
 
2024
    def test_falls_back_to_COLUMNS(self):
 
2025
        self.overrideEnv('BZR_COLUMNS', None)
 
2026
        self.assertNotEqual('42', os.environ['COLUMNS'])
 
2027
        self.set_fake_tty()
 
2028
        self.overrideEnv('COLUMNS', '42')
 
2029
        self.assertEqual(42, osutils.terminal_width())
 
2030
 
 
2031
    def test_tty_default_without_columns(self):
 
2032
        self.overrideEnv('BZR_COLUMNS', None)
 
2033
        self.overrideEnv('COLUMNS', None)
 
2034
 
 
2035
        def terminal_size(w, h):
 
2036
            return 42, 42
 
2037
 
 
2038
        self.set_fake_tty()
 
2039
        # We need to override the osutils definition as it depends on the
 
2040
        # running environment that we can't control (PQM running without a
 
2041
        # controlling terminal is one example).
 
2042
        self.replace__terminal_size(terminal_size)
 
2043
        self.assertEqual(42, osutils.terminal_width())
 
2044
 
 
2045
    def test_non_tty_default_without_columns(self):
 
2046
        self.overrideEnv('BZR_COLUMNS', None)
 
2047
        self.overrideEnv('COLUMNS', None)
 
2048
        self.replace_stdout(None)
 
2049
        self.assertEqual(None, osutils.terminal_width())
 
2050
 
 
2051
    def test_no_TIOCGWINSZ(self):
 
2052
        self.requireFeature(term_ios_feature)
 
2053
        termios = term_ios_feature.module
 
2054
        # bug 63539 is about a termios without TIOCGWINSZ attribute
 
2055
        try:
 
2056
            orig = termios.TIOCGWINSZ
 
2057
        except AttributeError:
 
2058
            # We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
 
2059
            pass
 
2060
        else:
 
2061
            self.overrideAttr(termios, 'TIOCGWINSZ')
 
2062
            del termios.TIOCGWINSZ
 
2063
        self.overrideEnv('BZR_COLUMNS', None)
 
2064
        self.overrideEnv('COLUMNS', None)
 
2065
        # Whatever the result is, if we don't raise an exception, it's ok.
 
2066
        osutils.terminal_width()
 
2067
 
 
2068
 
 
2069
class TestCreationOps(tests.TestCaseInTempDir):
 
2070
    _test_needs_features = [features.chown_feature]
 
2071
 
 
2072
    def setUp(self):
 
2073
        tests.TestCaseInTempDir.setUp(self)
 
2074
        self.overrideAttr(os, 'chown', self._dummy_chown)
 
2075
 
 
2076
        # params set by call to _dummy_chown
 
2077
        self.path = self.uid = self.gid = None
 
2078
 
 
2079
    def _dummy_chown(self, path, uid, gid):
 
2080
        self.path, self.uid, self.gid = path, uid, gid
 
2081
 
 
2082
    def test_copy_ownership_from_path(self):
 
2083
        """copy_ownership_from_path test with specified src."""
 
2084
        ownsrc = '/'
 
2085
        f = open('test_file', 'wt')
 
2086
        osutils.copy_ownership_from_path('test_file', ownsrc)
 
2087
 
 
2088
        s = os.stat(ownsrc)
 
2089
        self.assertEquals(self.path, 'test_file')
 
2090
        self.assertEquals(self.uid, s.st_uid)
 
2091
        self.assertEquals(self.gid, s.st_gid)
 
2092
 
 
2093
    def test_copy_ownership_nonesrc(self):
 
2094
        """copy_ownership_from_path test with src=None."""
 
2095
        f = open('test_file', 'wt')
 
2096
        # should use parent dir for permissions
 
2097
        osutils.copy_ownership_from_path('test_file')
 
2098
 
 
2099
        s = os.stat('..')
 
2100
        self.assertEquals(self.path, 'test_file')
 
2101
        self.assertEquals(self.uid, s.st_uid)
 
2102
        self.assertEquals(self.gid, s.st_gid)
 
2103
 
 
2104
 
 
2105
class TestGetuserUnicode(tests.TestCase):
 
2106
 
 
2107
    def test_ascii_user(self):
 
2108
        self.overrideEnv('LOGNAME', 'jrandom')
 
2109
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
 
2110
 
 
2111
    def test_unicode_user(self):
 
2112
        ue = osutils.get_user_encoding()
 
2113
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
2114
        if uni_val is None:
 
2115
            raise tests.TestSkipped(
 
2116
                'Cannot find a unicode character that works in encoding %s'
 
2117
                % (osutils.get_user_encoding(),))
 
2118
        uni_username = u'jrandom' + uni_val
 
2119
        encoded_username = uni_username.encode(ue)
 
2120
        self.overrideEnv('LOGNAME', encoded_username)
 
2121
        self.assertEqual(uni_username, osutils.getuser_unicode())
 
2122
        self.overrideEnv('LOGNAME', u'jrandom\xb6'.encode(ue))
 
2123
        self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
 
2124
 
 
2125
    def test_no_username_bug_660174(self):
 
2126
        self.requireFeature(features.win32_feature)
 
2127
        for name in ('LOGNAME', 'USER', 'LNAME', 'USERNAME'):
 
2128
            self.overrideEnv(name, None)
 
2129
        self.assertEqual(u'UNKNOWN', osutils.getuser_unicode())
 
2130
 
 
2131
 
 
2132
class TestBackupNames(tests.TestCase):
 
2133
 
 
2134
    def setUp(self):
 
2135
        super(TestBackupNames, self).setUp()
 
2136
        self.backups = []
 
2137
 
 
2138
    def backup_exists(self, name):
 
2139
        return name in self.backups
 
2140
 
 
2141
    def available_backup_name(self, name):
 
2142
        backup_name = osutils.available_backup_name(name, self.backup_exists)
 
2143
        self.backups.append(backup_name)
 
2144
        return backup_name
 
2145
 
 
2146
    def assertBackupName(self, expected, name):
 
2147
        self.assertEqual(expected, self.available_backup_name(name))
 
2148
 
 
2149
    def test_empty(self):
 
2150
        self.assertBackupName('file.~1~', 'file')
 
2151
 
 
2152
    def test_existing(self):
 
2153
        self.available_backup_name('file')
 
2154
        self.available_backup_name('file')
 
2155
        self.assertBackupName('file.~3~', 'file')
 
2156
        # Empty slots are found, this is not a strict requirement and may be
 
2157
        # revisited if we test against all implementations.
 
2158
        self.backups.remove('file.~2~')
 
2159
        self.assertBackupName('file.~2~', 'file')
 
2160
 
 
2161
 
 
2162
class TestFindExecutableInPath(tests.TestCase):
 
2163
 
 
2164
    def test_windows(self):
 
2165
        if sys.platform != 'win32':
 
2166
            raise tests.TestSkipped('test requires win32')
 
2167
        self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
 
2168
        self.assertTrue(
 
2169
            osutils.find_executable_on_path('explorer.exe') is not None)
 
2170
        self.assertTrue(
 
2171
            osutils.find_executable_on_path('EXPLORER.EXE') is not None)
 
2172
        self.assertTrue(
 
2173
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2174
        self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
 
2175
 
 
2176
    def test_other(self):
 
2177
        if sys.platform == 'win32':
 
2178
            raise tests.TestSkipped('test requires non-win32')
 
2179
        self.assertTrue(osutils.find_executable_on_path('sh') is not None)
 
2180
        self.assertTrue(
 
2181
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)