← 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: Vincent Ladeuil
  • Date: 2016-01-21 09:52:36 UTC
  • mto: This revision was merged to the branch mainline in revision 6611.
  • Revision ID: v.ladeuil+lp@free.fr-20160121095236-iandk0fic0phu9ey
Fix the failing gpg test on wily.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_osutils.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2015 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
20
20
import errno
21
21
import os
22
22
import re
 
23
import select
23
24
import socket
24
 
import stat
25
25
import sys
 
26
import tempfile
26
27
import time
27
28
 
28
29
from bzrlib import (
29
30
    errors,
 
31
    lazy_regex,
30
32
    osutils,
 
33
    symbol_versioning,
31
34
    tests,
32
35
    trace,
33
36
    win32utils,
34
37
    )
35
38
from bzrlib.tests import (
 
39
    features,
36
40
    file_utils,
37
41
    test__walkdirs_win32,
38
42
    )
39
 
 
40
 
 
41
 
class _UTF8DirReaderFeature(tests.Feature):
 
43
from bzrlib.tests.scenarios import load_tests_apply_scenarios
 
44
 
 
45
 
 
46
class _UTF8DirReaderFeature(features.Feature):
42
47
 
43
48
    def _probe(self):
44
49
        try:
51
56
    def feature_name(self):
52
57
        return 'bzrlib._readdir_pyx'
53
58
 
54
 
UTF8DirReaderFeature = _UTF8DirReaderFeature()
 
59
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
55
60
 
56
 
term_ios_feature = tests.ModuleAvailableFeature('termios')
 
61
term_ios_feature = features.ModuleAvailableFeature('termios')
57
62
 
58
63
 
59
64
def _already_unicode(s):
94
99
    return scenarios
95
100
 
96
101
 
97
 
def load_tests(basic_tests, module, loader):
98
 
    suite = loader.suiteClass()
99
 
    dir_reader_tests, remaining_tests = tests.split_suite_by_condition(
100
 
        basic_tests, tests.condition_isinstance(TestDirReader))
101
 
    tests.multiply_tests(dir_reader_tests, dir_reader_scenarios(), suite)
102
 
    suite.addTest(remaining_tests)
103
 
    return suite
 
102
load_tests = load_tests_apply_scenarios
104
103
 
105
104
 
106
105
class TestContainsWhitespace(tests.TestCase):
107
106
 
108
107
    def test_contains_whitespace(self):
109
 
        self.failUnless(osutils.contains_whitespace(u' '))
110
 
        self.failUnless(osutils.contains_whitespace(u'hello there'))
111
 
        self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
112
 
        self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
113
 
        self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
114
 
        self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
 
108
        self.assertTrue(osutils.contains_whitespace(u' '))
 
109
        self.assertTrue(osutils.contains_whitespace(u'hello there'))
 
110
        self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
 
111
        self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
 
112
        self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
 
113
        self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
115
114
 
116
115
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
117
116
        # is whitespace, but we do not.
118
 
        self.failIf(osutils.contains_whitespace(u''))
119
 
        self.failIf(osutils.contains_whitespace(u'hellothere'))
120
 
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
 
117
        self.assertFalse(osutils.contains_whitespace(u''))
 
118
        self.assertFalse(osutils.contains_whitespace(u'hellothere'))
 
119
        self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
121
120
 
122
121
 
123
122
class TestRename(tests.TestCaseInTempDir):
137
136
        # This should work everywhere
138
137
        self.create_file('a', 'something in a\n')
139
138
        self._fancy_rename('a', 'b')
140
 
        self.failIfExists('a')
141
 
        self.failUnlessExists('b')
 
139
        self.assertPathDoesNotExist('a')
 
140
        self.assertPathExists('b')
142
141
        self.check_file_contents('b', 'something in a\n')
143
142
 
144
143
        self.create_file('a', 'new something in a\n')
151
150
        self.create_file('target', 'data in target\n')
152
151
        self.assertRaises((IOError, OSError), self._fancy_rename,
153
152
                          'missingsource', 'target')
154
 
        self.failUnlessExists('target')
 
153
        self.assertPathExists('target')
155
154
        self.check_file_contents('target', 'data in target\n')
156
155
 
157
156
    def test_fancy_rename_fails_if_source_and_target_missing(self):
162
161
        # Rename should be semi-atomic on all platforms
163
162
        self.create_file('a', 'something in a\n')
164
163
        osutils.rename('a', 'b')
165
 
        self.failIfExists('a')
166
 
        self.failUnlessExists('b')
 
164
        self.assertPathDoesNotExist('a')
 
165
        self.assertPathExists('b')
167
166
        self.check_file_contents('b', 'something in a\n')
168
167
 
169
168
        self.create_file('a', 'new something in a\n')
183
182
        shape = sorted(os.listdir('.'))
184
183
        self.assertEquals(['A', 'B'], shape)
185
184
 
 
185
    def test_rename_exception(self):
 
186
        try:
 
187
            osutils.rename('nonexistent_path', 'different_nonexistent_path')
 
188
        except OSError, e:
 
189
            self.assertEqual(e.old_filename, 'nonexistent_path')
 
190
            self.assertEqual(e.new_filename, 'different_nonexistent_path')
 
191
            self.assertTrue('nonexistent_path' in e.strerror)
 
192
            self.assertTrue('different_nonexistent_path' in e.strerror)
 
193
 
186
194
 
187
195
class TestRandChars(tests.TestCase):
188
196
 
234
242
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
235
243
 
236
244
 
 
245
class TestLstat(tests.TestCaseInTempDir):
 
246
 
 
247
    def test_lstat_matches_fstat(self):
 
248
        # On Windows, lstat and fstat don't always agree, primarily in the
 
249
        # 'st_ino' and 'st_dev' fields. So we force them to be '0' in our
 
250
        # custom implementation.
 
251
        if sys.platform == 'win32':
 
252
            # We only have special lstat/fstat if we have the extension.
 
253
            # Without it, we may end up re-reading content when we don't have
 
254
            # to, but otherwise it doesn't effect correctness.
 
255
            self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
256
        f = open('test-file.txt', 'wb')
 
257
        self.addCleanup(f.close)
 
258
        f.write('some content\n')
 
259
        f.flush()
 
260
        self.assertEqualStat(osutils.fstat(f.fileno()),
 
261
                             osutils.lstat('test-file.txt'))
 
262
 
 
263
 
237
264
class TestRmTree(tests.TestCaseInTempDir):
238
265
 
239
266
    def test_rmtree(self):
251
278
 
252
279
        osutils.rmtree('dir')
253
280
 
254
 
        self.failIfExists('dir/file')
255
 
        self.failIfExists('dir')
 
281
        self.assertPathDoesNotExist('dir/file')
 
282
        self.assertPathDoesNotExist('dir')
256
283
 
257
284
 
258
285
class TestDeleteAny(tests.TestCaseInTempDir):
410
437
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
411
438
 
412
439
 
 
440
class TestFdatasync(tests.TestCaseInTempDir):
 
441
 
 
442
    def do_fdatasync(self):
 
443
        f = tempfile.NamedTemporaryFile()
 
444
        osutils.fdatasync(f.fileno())
 
445
        f.close()
 
446
 
 
447
    @staticmethod
 
448
    def raise_eopnotsupp(*args, **kwargs):
 
449
        raise IOError(errno.EOPNOTSUPP, os.strerror(errno.EOPNOTSUPP))
 
450
 
 
451
    @staticmethod
 
452
    def raise_enotsup(*args, **kwargs):
 
453
        raise IOError(errno.ENOTSUP, os.strerror(errno.ENOTSUP))
 
454
 
 
455
    def test_fdatasync_handles_system_function(self):
 
456
        self.overrideAttr(os, "fdatasync")
 
457
        self.do_fdatasync()
 
458
 
 
459
    def test_fdatasync_handles_no_fdatasync_no_fsync(self):
 
460
        self.overrideAttr(os, "fdatasync")
 
461
        self.overrideAttr(os, "fsync")
 
462
        self.do_fdatasync()
 
463
 
 
464
    def test_fdatasync_handles_no_EOPNOTSUPP(self):
 
465
        self.overrideAttr(errno, "EOPNOTSUPP")
 
466
        self.do_fdatasync()
 
467
 
 
468
    def test_fdatasync_catches_ENOTSUP(self):
 
469
        enotsup = getattr(errno, "ENOTSUP", None)
 
470
        if enotsup is None:
 
471
            raise tests.TestNotApplicable("No ENOTSUP on this platform")
 
472
        self.overrideAttr(os, "fdatasync", self.raise_enotsup)
 
473
        self.do_fdatasync()
 
474
 
 
475
    def test_fdatasync_catches_EOPNOTSUPP(self):
 
476
        enotsup = getattr(errno, "EOPNOTSUPP", None)
 
477
        if enotsup is None:
 
478
            raise tests.TestNotApplicable("No EOPNOTSUPP on this platform")
 
479
        self.overrideAttr(os, "fdatasync", self.raise_eopnotsupp)
 
480
        self.do_fdatasync()
 
481
 
 
482
 
413
483
class TestLinks(tests.TestCaseInTempDir):
414
484
 
415
485
    def test_dereference_path(self):
416
 
        self.requireFeature(tests.SymlinkFeature)
 
486
        self.requireFeature(features.SymlinkFeature)
417
487
        cwd = osutils.realpath('.')
418
488
        os.mkdir('bar')
419
489
        bar_path = osutils.pathjoin(cwd, 'bar')
466
536
 
467
537
class TestCanonicalRelPath(tests.TestCaseInTempDir):
468
538
 
469
 
    _test_needs_features = [tests.CaseInsCasePresFilenameFeature]
 
539
    _test_needs_features = [features.CaseInsCasePresFilenameFeature]
470
540
 
471
541
    def test_canonical_relpath_simple(self):
472
542
        f = file('MixedCaseName', 'w')
473
543
        f.close()
474
544
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
475
 
        self.failUnlessEqual('work/MixedCaseName', actual)
 
545
        self.assertEqual('work/MixedCaseName', actual)
476
546
 
477
547
    def test_canonical_relpath_missing_tail(self):
478
548
        os.mkdir('MixedCaseParent')
479
549
        actual = osutils.canonical_relpath(self.test_base_dir,
480
550
                                           'mixedcaseparent/nochild')
481
 
        self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
 
551
        self.assertEqual('work/MixedCaseParent/nochild', actual)
482
552
 
483
553
 
484
554
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
528
598
    """Test pumpfile method."""
529
599
 
530
600
    def setUp(self):
531
 
        tests.TestCase.setUp(self)
 
601
        super(TestPumpFile, self).setUp()
532
602
        # create a test datablock
533
603
        self.block_size = 512
534
604
        pattern = '0123456789ABCDEF'
802
872
        self.assertEqual(None, osutils.safe_file_id(None))
803
873
 
804
874
 
 
875
class TestSendAll(tests.TestCase):
 
876
 
 
877
    def test_send_with_disconnected_socket(self):
 
878
        class DisconnectedSocket(object):
 
879
            def __init__(self, err):
 
880
                self.err = err
 
881
            def send(self, content):
 
882
                raise self.err
 
883
            def close(self):
 
884
                pass
 
885
        # All of these should be treated as ConnectionReset
 
886
        errs = []
 
887
        for err_cls in (IOError, socket.error):
 
888
            for errnum in osutils._end_of_stream_errors:
 
889
                errs.append(err_cls(errnum))
 
890
        for err in errs:
 
891
            sock = DisconnectedSocket(err)
 
892
            self.assertRaises(errors.ConnectionReset,
 
893
                osutils.send_all, sock, 'some more content')
 
894
 
 
895
    def test_send_with_no_progress(self):
 
896
        # See https://bugs.launchpad.net/bzr/+bug/1047309
 
897
        # It seems that paramiko can get into a state where it doesn't error,
 
898
        # but it returns 0 bytes sent for requests over and over again.
 
899
        class NoSendingSocket(object):
 
900
            def __init__(self):
 
901
                self.call_count = 0
 
902
            def send(self, bytes):
 
903
                self.call_count += 1
 
904
                if self.call_count > 100:
 
905
                    # Prevent the test suite from hanging
 
906
                    raise RuntimeError('too many calls')
 
907
                return 0
 
908
        sock = NoSendingSocket()
 
909
        self.assertRaises(errors.ConnectionReset,
 
910
                          osutils.send_all, sock, 'content')
 
911
        self.assertEqual(1, sock.call_count)
 
912
 
 
913
 
 
914
class TestPosixFuncs(tests.TestCase):
 
915
    """Test that the posix version of normpath returns an appropriate path
 
916
       when used with 2 leading slashes."""
 
917
 
 
918
    def test_normpath(self):
 
919
        self.assertEqual('/etc/shadow', osutils._posix_normpath('/etc/shadow'))
 
920
        self.assertEqual('/etc/shadow', osutils._posix_normpath('//etc/shadow'))
 
921
        self.assertEqual('/etc/shadow', osutils._posix_normpath('///etc/shadow'))
 
922
 
 
923
 
805
924
class TestWin32Funcs(tests.TestCase):
806
925
    """Test that _win32 versions of os utilities return appropriate paths."""
807
926
 
808
927
    def test_abspath(self):
 
928
        self.requireFeature(features.win32_feature)
809
929
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
810
930
        self.assertEqual('C:/foo', osutils._win32_abspath('C:/foo'))
811
931
        self.assertEqual('//HOST/path', osutils._win32_abspath(r'\\HOST\path'))
824
944
                         osutils._win32_pathjoin('path/to', 'C:/foo'))
825
945
        self.assertEqual('path/to/foo',
826
946
                         osutils._win32_pathjoin('path/to/', 'foo'))
827
 
        self.assertEqual('/foo',
 
947
 
 
948
    def test_pathjoin_late_bugfix(self):
 
949
        if sys.version_info < (2, 7, 6):
 
950
            expected = '/foo'
 
951
        else:
 
952
            expected = 'C:/foo'
 
953
        self.assertEqual(expected,
828
954
                         osutils._win32_pathjoin('C:/path/to/', '/foo'))
829
 
        self.assertEqual('/foo',
 
955
        self.assertEqual(expected,
830
956
                         osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
831
957
 
832
958
    def test_normpath(self):
852
978
        self.assertEqual('C:\\foo', osutils._win32_fixdrive('c:\\foo'))
853
979
 
854
980
    def test_win98_abspath(self):
 
981
        self.requireFeature(features.win32_feature)
855
982
        # absolute path
856
983
        self.assertEqual('C:/foo', osutils._win98_abspath('C:\\foo'))
857
984
        self.assertEqual('C:/foo', osutils._win98_abspath('C:/foo'))
860
987
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
861
988
        # relative path
862
989
        cwd = osutils.getcwd().rstrip('/')
863
 
        drive = osutils._nt_splitdrive(cwd)[0]
 
990
        drive = osutils.ntpath.splitdrive(cwd)[0]
864
991
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
865
992
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
866
993
        # unicode path
872
999
    """Test win32 functions that create files."""
873
1000
 
874
1001
    def test_getcwd(self):
875
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1002
        self.requireFeature(features.UnicodeFilenameFeature)
876
1003
        os.mkdir(u'mu-\xb5')
877
1004
        os.chdir(u'mu-\xb5')
878
1005
        # TODO: jam 20060427 This will probably fail on Mac OSX because
908
1035
        b.close()
909
1036
 
910
1037
        osutils._win32_rename('b', 'a')
911
 
        self.failUnlessExists('a')
912
 
        self.failIfExists('b')
 
1038
        self.assertPathExists('a')
 
1039
        self.assertPathDoesNotExist('b')
913
1040
        self.assertFileEqual('baz\n', 'a')
914
1041
 
915
1042
    def test_rename_missing_file(self):
968
1095
    """Test mac special functions that require directories."""
969
1096
 
970
1097
    def test_getcwd(self):
971
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1098
        self.requireFeature(features.UnicodeFilenameFeature)
972
1099
        os.mkdir(u'B\xe5gfors')
973
1100
        os.chdir(u'B\xe5gfors')
974
1101
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
975
1102
 
976
1103
    def test_getcwd_nonnorm(self):
977
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1104
        self.requireFeature(features.UnicodeFilenameFeature)
978
1105
        # Test that _mac_getcwd() will normalize this path
979
1106
        os.mkdir(u'Ba\u030agfors')
980
1107
        os.chdir(u'Ba\u030agfors')
1063
1190
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
1064
1191
 
1065
1192
    def test_walkdirs_os_error(self):
1066
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/338653>
 
1193
        # <https://bugs.launchpad.net/bzr/+bug/338653>
1067
1194
        # Pyrex readdir didn't raise useful messages if it had an error
1068
1195
        # reading the directory
1069
1196
        if sys.platform == 'win32':
1070
1197
            raise tests.TestNotApplicable(
1071
1198
                "readdir IOError not tested on win32")
 
1199
        self.requireFeature(features.not_running_as_root)
1072
1200
        os.mkdir("test-unreadable")
1073
1201
        os.chmod("test-unreadable", 0000)
1074
1202
        # must chmod it back so that it can be removed
1082
1210
        # Ensure the message contains the file name
1083
1211
        self.assertContainsRe(str(e), "\./test-unreadable")
1084
1212
 
 
1213
 
 
1214
    def test_walkdirs_encoding_error(self):
 
1215
        # <https://bugs.launchpad.net/bzr/+bug/488519>
 
1216
        # walkdirs didn't raise a useful message when the filenames
 
1217
        # are not using the filesystem's encoding
 
1218
 
 
1219
        # require a bytestring based filesystem
 
1220
        self.requireFeature(features.ByteStringNamedFilesystem)
 
1221
 
 
1222
        tree = [
 
1223
            '.bzr',
 
1224
            '0file',
 
1225
            '1dir/',
 
1226
            '1dir/0file',
 
1227
            '1dir/1dir/',
 
1228
            '1file'
 
1229
            ]
 
1230
 
 
1231
        self.build_tree(tree)
 
1232
 
 
1233
        # rename the 1file to a latin-1 filename
 
1234
        os.rename("./1file", "\xe8file")
 
1235
        if "\xe8file" not in os.listdir("."):
 
1236
            self.skip("Lack filesystem that preserves arbitrary bytes")
 
1237
 
 
1238
        self._save_platform_info()
 
1239
        win32utils.winver = None # Avoid the win32 detection code
 
1240
        osutils._fs_enc = 'UTF-8'
 
1241
 
 
1242
        # this should raise on error
 
1243
        def attempt():
 
1244
            for dirdetail, dirblock in osutils.walkdirs('.'):
 
1245
                pass
 
1246
 
 
1247
        self.assertRaises(errors.BadFilenameEncoding, attempt)
 
1248
 
1085
1249
    def test__walkdirs_utf8(self):
1086
1250
        tree = [
1087
1251
            '.bzr',
1153
1317
        self.requireFeature(UTF8DirReaderFeature)
1154
1318
        self._save_platform_info()
1155
1319
        win32utils.winver = None # Avoid the win32 detection code
1156
 
        osutils._fs_enc = 'UTF-8'
1157
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1320
        osutils._fs_enc = 'utf-8'
 
1321
        self.assertDirReaderIs(
 
1322
            UTF8DirReaderFeature.module.UTF8DirReader)
1158
1323
 
1159
1324
    def test_force_walkdirs_utf8_fs_ascii(self):
1160
1325
        self.requireFeature(UTF8DirReaderFeature)
1161
1326
        self._save_platform_info()
1162
1327
        win32utils.winver = None # Avoid the win32 detection code
1163
 
        osutils._fs_enc = 'US-ASCII'
1164
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1165
 
 
1166
 
    def test_force_walkdirs_utf8_fs_ANSI(self):
1167
 
        self.requireFeature(UTF8DirReaderFeature)
1168
 
        self._save_platform_info()
1169
 
        win32utils.winver = None # Avoid the win32 detection code
1170
 
        osutils._fs_enc = 'ANSI_X3.4-1968'
1171
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1328
        osutils._fs_enc = 'ascii'
 
1329
        self.assertDirReaderIs(
 
1330
            UTF8DirReaderFeature.module.UTF8DirReader)
1172
1331
 
1173
1332
    def test_force_walkdirs_utf8_fs_latin1(self):
1174
1333
        self._save_platform_info()
1175
1334
        win32utils.winver = None # Avoid the win32 detection code
1176
 
        osutils._fs_enc = 'latin1'
 
1335
        osutils._fs_enc = 'iso-8859-1'
1177
1336
        self.assertDirReaderIs(osutils.UnicodeDirReader)
1178
1337
 
1179
1338
    def test_force_walkdirs_utf8_nt(self):
1192
1351
 
1193
1352
    def test_unicode_walkdirs(self):
1194
1353
        """Walkdirs should always return unicode paths."""
1195
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1354
        self.requireFeature(features.UnicodeFilenameFeature)
1196
1355
        name0 = u'0file-\xb6'
1197
1356
        name1 = u'1dir-\u062c\u0648'
1198
1357
        name2 = u'2file-\u0633'
1235
1394
 
1236
1395
        The abspath portion might be in unicode or utf-8
1237
1396
        """
1238
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1397
        self.requireFeature(features.UnicodeFilenameFeature)
1239
1398
        name0 = u'0file-\xb6'
1240
1399
        name1 = u'1dir-\u062c\u0648'
1241
1400
        name2 = u'2file-\u0633'
1296
1455
 
1297
1456
        The abspath portion should be in unicode
1298
1457
        """
1299
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1458
        self.requireFeature(features.UnicodeFilenameFeature)
1300
1459
        # Use the unicode reader. TODO: split into driver-and-driven unit
1301
1460
        # tests.
1302
1461
        self._save_platform_info()
1343
1502
 
1344
1503
    def test__walkdirs_utf8_win32readdir(self):
1345
1504
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1346
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1505
        self.requireFeature(features.UnicodeFilenameFeature)
1347
1506
        from bzrlib._walkdirs_win32 import Win32ReadDir
1348
1507
        self._save_platform_info()
1349
1508
        osutils._selected_dir_reader = Win32ReadDir()
1400
1559
    def test__walkdirs_utf_win32_find_file_stat_file(self):
1401
1560
        """make sure our Stat values are valid"""
1402
1561
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1403
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1562
        self.requireFeature(features.UnicodeFilenameFeature)
1404
1563
        from bzrlib._walkdirs_win32 import Win32ReadDir
1405
1564
        name0u = u'0file-\xb6'
1406
1565
        name0 = name0u.encode('utf8')
1424
1583
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
1425
1584
        """make sure our Stat values are valid"""
1426
1585
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1427
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1586
        self.requireFeature(features.UnicodeFilenameFeature)
1428
1587
        from bzrlib._walkdirs_win32 import Win32ReadDir
1429
1588
        name0u = u'0dir-\u062c\u0648'
1430
1589
        name0 = name0u.encode('utf8')
1530
1689
        self.assertEqual(['c'], os.listdir('target/b'))
1531
1690
 
1532
1691
    def test_copy_tree_symlinks(self):
1533
 
        self.requireFeature(tests.SymlinkFeature)
 
1692
        self.requireFeature(features.SymlinkFeature)
1534
1693
        self.build_tree(['source/'])
1535
1694
        os.symlink('a/generic/path', 'source/lnk')
1536
1695
        osutils.copy_tree('source', 'target')
1561
1720
                          ('d', 'source/b', 'target/b'),
1562
1721
                          ('f', 'source/b/c', 'target/b/c'),
1563
1722
                         ], processed_files)
1564
 
        self.failIfExists('target')
 
1723
        self.assertPathDoesNotExist('target')
1565
1724
        if osutils.has_symlinks():
1566
1725
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1567
1726
 
1613
1772
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1614
1773
        self.assertEqual('foo', old)
1615
1774
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1616
 
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
 
1775
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1617
1776
 
1618
1777
 
1619
1778
class TestSizeShaFile(tests.TestCaseInTempDir):
1670
1829
 
1671
1830
class TestReCompile(tests.TestCase):
1672
1831
 
 
1832
    def _deprecated_re_compile_checked(self, *args, **kwargs):
 
1833
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
 
1834
            osutils.re_compile_checked, *args, **kwargs)
 
1835
 
1673
1836
    def test_re_compile_checked(self):
1674
 
        r = osutils.re_compile_checked(r'A*', re.IGNORECASE)
 
1837
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1675
1838
        self.assertTrue(r.match('aaaa'))
1676
1839
        self.assertTrue(r.match('aAaA'))
1677
1840
 
1678
1841
    def test_re_compile_checked_error(self):
1679
1842
        # like https://bugs.launchpad.net/bzr/+bug/251352
 
1843
 
 
1844
        # Due to possible test isolation error, re.compile is not lazy at
 
1845
        # this point. We re-install lazy compile.
 
1846
        lazy_regex.install_lazy_compile()
1680
1847
        err = self.assertRaises(
1681
1848
            errors.BzrCommandError,
1682
 
            osutils.re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1849
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1683
1850
        self.assertEqual(
1684
 
            "Invalid regular expression in test case: '*': "
1685
 
            "nothing to repeat",
 
1851
            'Invalid regular expression in test case: '
 
1852
            '"*" nothing to repeat',
1686
1853
            str(err))
1687
1854
 
1688
1855
 
1689
1856
class TestDirReader(tests.TestCaseInTempDir):
1690
1857
 
 
1858
    scenarios = dir_reader_scenarios()
 
1859
 
1691
1860
    # Set by load_tests
1692
1861
    _dir_reader_class = None
1693
1862
    _native_to_unicode = None
1694
1863
 
1695
1864
    def setUp(self):
1696
 
        tests.TestCaseInTempDir.setUp(self)
 
1865
        super(TestDirReader, self).setUp()
1697
1866
        self.overrideAttr(osutils,
1698
1867
                          '_selected_dir_reader', self._dir_reader_class())
1699
1868
 
1793
1962
        return filtered_dirblocks
1794
1963
 
1795
1964
    def test_walk_unicode_tree(self):
1796
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1965
        self.requireFeature(features.UnicodeFilenameFeature)
1797
1966
        tree, expected_dirblocks = self._get_unicode_tree()
1798
1967
        self.build_tree(tree)
1799
1968
        result = list(osutils._walkdirs_utf8('.'))
1800
1969
        self.assertEqual(expected_dirblocks, self._filter_out(result))
1801
1970
 
1802
1971
    def test_symlink(self):
1803
 
        self.requireFeature(tests.SymlinkFeature)
1804
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1972
        self.requireFeature(features.SymlinkFeature)
 
1973
        self.requireFeature(features.UnicodeFilenameFeature)
1805
1974
        target = u'target\N{Euro Sign}'
1806
1975
        link_name = u'l\N{Euro Sign}nk'
1807
1976
        os.symlink(target, link_name)
1825
1994
    But prior python versions failed to properly encode the passed unicode
1826
1995
    string.
1827
1996
    """
1828
 
    _test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
 
1997
    _test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
1829
1998
 
1830
1999
    def setUp(self):
1831
2000
        super(tests.TestCaseInTempDir, self).setUp()
1834
2003
        os.symlink(self.target, self.link)
1835
2004
 
1836
2005
    def test_os_readlink_link_encoding(self):
1837
 
        if sys.version_info < (2, 6):
1838
 
            self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
1839
 
        else:
1840
 
            self.assertEquals(self.target,  os.readlink(self.link))
 
2006
        self.assertEquals(self.target,  os.readlink(self.link))
1841
2007
 
1842
2008
    def test_os_readlink_link_decoding(self):
1843
2009
        self.assertEquals(self.target.encode(osutils._fs_enc),
1855
2021
        self.assertIsInstance(concurrency, int)
1856
2022
 
1857
2023
    def test_local_concurrency_environment_variable(self):
1858
 
        os.environ['BZR_CONCURRENCY'] = '2'
 
2024
        self.overrideEnv('BZR_CONCURRENCY', '2')
1859
2025
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1860
 
        os.environ['BZR_CONCURRENCY'] = '3'
 
2026
        self.overrideEnv('BZR_CONCURRENCY', '3')
1861
2027
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1862
 
        os.environ['BZR_CONCURRENCY'] = 'foo'
 
2028
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
1863
2029
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1864
2030
 
1865
2031
    def test_option_concurrency(self):
1866
 
        os.environ['BZR_CONCURRENCY'] = '1'
 
2032
        self.overrideEnv('BZR_CONCURRENCY', '1')
1867
2033
        self.run_bzr('rocks --concurrency 42')
1868
 
        # Command line overrides envrionment variable
 
2034
        # Command line overrides environment variable
1869
2035
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1870
2036
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
1871
2037
 
1909
2075
 
1910
2076
class TestTerminalWidth(tests.TestCase):
1911
2077
 
 
2078
    def setUp(self):
 
2079
        super(TestTerminalWidth, self).setUp()
 
2080
        self._orig_terminal_size_state = osutils._terminal_size_state
 
2081
        self._orig_first_terminal_size = osutils._first_terminal_size
 
2082
        self.addCleanup(self.restore_osutils_globals)
 
2083
        osutils._terminal_size_state = 'no_data'
 
2084
        osutils._first_terminal_size = None
 
2085
 
 
2086
    def restore_osutils_globals(self):
 
2087
        osutils._terminal_size_state = self._orig_terminal_size_state
 
2088
        osutils._first_terminal_size = self._orig_first_terminal_size
 
2089
 
1912
2090
    def replace_stdout(self, new):
1913
2091
        self.overrideAttr(sys, 'stdout', new)
1914
2092
 
1929
2107
    def test_defaults_to_BZR_COLUMNS(self):
1930
2108
        # BZR_COLUMNS is set by the test framework
1931
2109
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
1932
 
        os.environ['BZR_COLUMNS'] = '12'
 
2110
        self.overrideEnv('BZR_COLUMNS', '12')
1933
2111
        self.assertEqual(12, osutils.terminal_width())
1934
2112
 
 
2113
    def test_BZR_COLUMNS_0_no_limit(self):
 
2114
        self.overrideEnv('BZR_COLUMNS', '0')
 
2115
        self.assertEqual(None, osutils.terminal_width())
 
2116
 
1935
2117
    def test_falls_back_to_COLUMNS(self):
1936
 
        del os.environ['BZR_COLUMNS']
 
2118
        self.overrideEnv('BZR_COLUMNS', None)
1937
2119
        self.assertNotEqual('42', os.environ['COLUMNS'])
1938
2120
        self.set_fake_tty()
1939
 
        os.environ['COLUMNS'] = '42'
 
2121
        self.overrideEnv('COLUMNS', '42')
1940
2122
        self.assertEqual(42, osutils.terminal_width())
1941
2123
 
1942
2124
    def test_tty_default_without_columns(self):
1943
 
        del os.environ['BZR_COLUMNS']
1944
 
        del os.environ['COLUMNS']
 
2125
        self.overrideEnv('BZR_COLUMNS', None)
 
2126
        self.overrideEnv('COLUMNS', None)
1945
2127
 
1946
2128
        def terminal_size(w, h):
1947
2129
            return 42, 42
1954
2136
        self.assertEqual(42, osutils.terminal_width())
1955
2137
 
1956
2138
    def test_non_tty_default_without_columns(self):
1957
 
        del os.environ['BZR_COLUMNS']
1958
 
        del os.environ['COLUMNS']
 
2139
        self.overrideEnv('BZR_COLUMNS', None)
 
2140
        self.overrideEnv('COLUMNS', None)
1959
2141
        self.replace_stdout(None)
1960
2142
        self.assertEqual(None, osutils.terminal_width())
1961
2143
 
1971
2153
        else:
1972
2154
            self.overrideAttr(termios, 'TIOCGWINSZ')
1973
2155
            del termios.TIOCGWINSZ
1974
 
        del os.environ['BZR_COLUMNS']
1975
 
        del os.environ['COLUMNS']
 
2156
        self.overrideEnv('BZR_COLUMNS', None)
 
2157
        self.overrideEnv('COLUMNS', None)
1976
2158
        # Whatever the result is, if we don't raise an exception, it's ok.
1977
2159
        osutils.terminal_width()
 
2160
 
 
2161
 
 
2162
class TestCreationOps(tests.TestCaseInTempDir):
 
2163
    _test_needs_features = [features.chown_feature]
 
2164
 
 
2165
    def setUp(self):
 
2166
        super(TestCreationOps, self).setUp()
 
2167
        self.overrideAttr(os, 'chown', self._dummy_chown)
 
2168
 
 
2169
        # params set by call to _dummy_chown
 
2170
        self.path = self.uid = self.gid = None
 
2171
 
 
2172
    def _dummy_chown(self, path, uid, gid):
 
2173
        self.path, self.uid, self.gid = path, uid, gid
 
2174
 
 
2175
    def test_copy_ownership_from_path(self):
 
2176
        """copy_ownership_from_path test with specified src."""
 
2177
        ownsrc = '/'
 
2178
        f = open('test_file', 'wt')
 
2179
        osutils.copy_ownership_from_path('test_file', ownsrc)
 
2180
 
 
2181
        s = os.stat(ownsrc)
 
2182
        self.assertEquals(self.path, 'test_file')
 
2183
        self.assertEquals(self.uid, s.st_uid)
 
2184
        self.assertEquals(self.gid, s.st_gid)
 
2185
 
 
2186
    def test_copy_ownership_nonesrc(self):
 
2187
        """copy_ownership_from_path test with src=None."""
 
2188
        f = open('test_file', 'wt')
 
2189
        # should use parent dir for permissions
 
2190
        osutils.copy_ownership_from_path('test_file')
 
2191
 
 
2192
        s = os.stat('..')
 
2193
        self.assertEquals(self.path, 'test_file')
 
2194
        self.assertEquals(self.uid, s.st_uid)
 
2195
        self.assertEquals(self.gid, s.st_gid)
 
2196
 
 
2197
 
 
2198
class TestPathFromEnviron(tests.TestCase):
 
2199
 
 
2200
    def test_is_unicode(self):
 
2201
        self.overrideEnv('BZR_TEST_PATH', './anywhere at all/')
 
2202
        path = osutils.path_from_environ('BZR_TEST_PATH')
 
2203
        self.assertIsInstance(path, unicode)
 
2204
        self.assertEqual(u'./anywhere at all/', path)
 
2205
 
 
2206
    def test_posix_path_env_ascii(self):
 
2207
        self.overrideEnv('BZR_TEST_PATH', '/tmp')
 
2208
        home = osutils._posix_path_from_environ('BZR_TEST_PATH')
 
2209
        self.assertIsInstance(home, unicode)
 
2210
        self.assertEqual(u'/tmp', home)
 
2211
 
 
2212
    def test_posix_path_env_unicode(self):
 
2213
        self.requireFeature(features.ByteStringNamedFilesystem)
 
2214
        self.overrideEnv('BZR_TEST_PATH', '/home/\xa7test')
 
2215
        self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
 
2216
        self.assertEqual(u'/home/\xa7test',
 
2217
            osutils._posix_path_from_environ('BZR_TEST_PATH'))
 
2218
        osutils._fs_enc = "iso8859-5"
 
2219
        self.assertEqual(u'/home/\u0407test',
 
2220
            osutils._posix_path_from_environ('BZR_TEST_PATH'))
 
2221
        osutils._fs_enc = "utf-8"
 
2222
        self.assertRaises(errors.BadFilenameEncoding,
 
2223
            osutils._posix_path_from_environ, 'BZR_TEST_PATH')
 
2224
 
 
2225
 
 
2226
class TestGetHomeDir(tests.TestCase):
 
2227
 
 
2228
    def test_is_unicode(self):
 
2229
        home = osutils._get_home_dir()
 
2230
        self.assertIsInstance(home, unicode)
 
2231
 
 
2232
    def test_posix_homeless(self):
 
2233
        self.overrideEnv('HOME', None)
 
2234
        home = osutils._get_home_dir()
 
2235
        self.assertIsInstance(home, unicode)
 
2236
 
 
2237
    def test_posix_home_ascii(self):
 
2238
        self.overrideEnv('HOME', '/home/test')
 
2239
        home = osutils._posix_get_home_dir()
 
2240
        self.assertIsInstance(home, unicode)
 
2241
        self.assertEqual(u'/home/test', home)
 
2242
 
 
2243
    def test_posix_home_unicode(self):
 
2244
        self.requireFeature(features.ByteStringNamedFilesystem)
 
2245
        self.overrideEnv('HOME', '/home/\xa7test')
 
2246
        self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
 
2247
        self.assertEqual(u'/home/\xa7test', osutils._posix_get_home_dir())
 
2248
        osutils._fs_enc = "iso8859-5"
 
2249
        self.assertEqual(u'/home/\u0407test', osutils._posix_get_home_dir())
 
2250
        osutils._fs_enc = "utf-8"
 
2251
        self.assertRaises(errors.BadFilenameEncoding,
 
2252
            osutils._posix_get_home_dir)
 
2253
 
 
2254
 
 
2255
class TestGetuserUnicode(tests.TestCase):
 
2256
 
 
2257
    def test_is_unicode(self):
 
2258
        user = osutils.getuser_unicode()
 
2259
        self.assertIsInstance(user, unicode)
 
2260
 
 
2261
    def envvar_to_override(self):
 
2262
        if sys.platform == "win32":
 
2263
            # Disable use of platform calls on windows so envvar is used
 
2264
            self.overrideAttr(win32utils, 'has_ctypes', False)
 
2265
            return 'USERNAME' # only variable used on windows
 
2266
        return 'LOGNAME' # first variable checked by getpass.getuser()
 
2267
 
 
2268
    def test_ascii_user(self):
 
2269
        self.overrideEnv(self.envvar_to_override(), 'jrandom')
 
2270
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
 
2271
 
 
2272
    def test_unicode_user(self):
 
2273
        ue = osutils.get_user_encoding()
 
2274
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
2275
        if uni_val is None:
 
2276
            raise tests.TestSkipped(
 
2277
                'Cannot find a unicode character that works in encoding %s'
 
2278
                % (osutils.get_user_encoding(),))
 
2279
        uni_username = u'jrandom' + uni_val
 
2280
        encoded_username = uni_username.encode(ue)
 
2281
        self.overrideEnv(self.envvar_to_override(), encoded_username)
 
2282
        self.assertEqual(uni_username, osutils.getuser_unicode())
 
2283
 
 
2284
 
 
2285
class TestBackupNames(tests.TestCase):
 
2286
 
 
2287
    def setUp(self):
 
2288
        super(TestBackupNames, self).setUp()
 
2289
        self.backups = []
 
2290
 
 
2291
    def backup_exists(self, name):
 
2292
        return name in self.backups
 
2293
 
 
2294
    def available_backup_name(self, name):
 
2295
        backup_name = osutils.available_backup_name(name, self.backup_exists)
 
2296
        self.backups.append(backup_name)
 
2297
        return backup_name
 
2298
 
 
2299
    def assertBackupName(self, expected, name):
 
2300
        self.assertEqual(expected, self.available_backup_name(name))
 
2301
 
 
2302
    def test_empty(self):
 
2303
        self.assertBackupName('file.~1~', 'file')
 
2304
 
 
2305
    def test_existing(self):
 
2306
        self.available_backup_name('file')
 
2307
        self.available_backup_name('file')
 
2308
        self.assertBackupName('file.~3~', 'file')
 
2309
        # Empty slots are found, this is not a strict requirement and may be
 
2310
        # revisited if we test against all implementations.
 
2311
        self.backups.remove('file.~2~')
 
2312
        self.assertBackupName('file.~2~', 'file')
 
2313
 
 
2314
 
 
2315
class TestFindExecutableInPath(tests.TestCase):
 
2316
 
 
2317
    def test_windows(self):
 
2318
        if sys.platform != 'win32':
 
2319
            raise tests.TestSkipped('test requires win32')
 
2320
        self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
 
2321
        self.assertTrue(
 
2322
            osutils.find_executable_on_path('explorer.exe') is not None)
 
2323
        self.assertTrue(
 
2324
            osutils.find_executable_on_path('EXPLORER.EXE') is not None)
 
2325
        self.assertTrue(
 
2326
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2327
        self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
 
2328
        
 
2329
    def test_windows_app_path(self):
 
2330
        if sys.platform != 'win32':
 
2331
            raise tests.TestSkipped('test requires win32')
 
2332
        # Override PATH env var so that exe can only be found on App Path
 
2333
        self.overrideEnv('PATH', '')
 
2334
        # Internt Explorer is always registered in the App Path
 
2335
        self.assertTrue(osutils.find_executable_on_path('iexplore') is not None)
 
2336
 
 
2337
    def test_other(self):
 
2338
        if sys.platform == 'win32':
 
2339
            raise tests.TestSkipped('test requires non-win32')
 
2340
        self.assertTrue(osutils.find_executable_on_path('sh') is not None)
 
2341
        self.assertTrue(
 
2342
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2343
 
 
2344
 
 
2345
class TestEnvironmentErrors(tests.TestCase):
 
2346
    """Test handling of environmental errors"""
 
2347
 
 
2348
    def test_is_oserror(self):
 
2349
        self.assertTrue(osutils.is_environment_error(
 
2350
            OSError(errno.EINVAL, "Invalid parameter")))
 
2351
 
 
2352
    def test_is_ioerror(self):
 
2353
        self.assertTrue(osutils.is_environment_error(
 
2354
            IOError(errno.EINVAL, "Invalid parameter")))
 
2355
 
 
2356
    def test_is_socket_error(self):
 
2357
        self.assertTrue(osutils.is_environment_error(
 
2358
            socket.error(errno.EINVAL, "Invalid parameter")))
 
2359
 
 
2360
    def test_is_select_error(self):
 
2361
        self.assertTrue(osutils.is_environment_error(
 
2362
            select.error(errno.EINVAL, "Invalid parameter")))
 
2363
 
 
2364
    def test_is_pywintypes_error(self):
 
2365
        self.requireFeature(features.pywintypes)
 
2366
        import pywintypes
 
2367
        self.assertTrue(osutils.is_environment_error(
 
2368
            pywintypes.error(errno.EINVAL, "Invalid parameter", "Caller")))