← 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: 2017-01-17 13:48:10 UTC
  • mfrom: (6615.3.6 merges)
  • mto: This revision was merged to the branch mainline in revision 6620.
  • Revision ID: v.ladeuil+lp@free.fr-20170117134810-j9p3lidfy6pfyfsc
Merge 2.7, resolving conflicts

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-2016 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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 (
39
40
    file_utils,
40
41
    test__walkdirs_win32,
41
42
    )
42
 
 
43
 
 
44
 
class _UTF8DirReaderFeature(tests.Feature):
 
43
from bzrlib.tests.scenarios import load_tests_apply_scenarios
 
44
 
 
45
 
 
46
class _UTF8DirReaderFeature(features.Feature):
45
47
 
46
48
    def _probe(self):
47
49
        try:
54
56
    def feature_name(self):
55
57
        return 'bzrlib._readdir_pyx'
56
58
 
57
 
UTF8DirReaderFeature = _UTF8DirReaderFeature()
 
59
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
58
60
 
59
 
term_ios_feature = tests.ModuleAvailableFeature('termios')
 
61
term_ios_feature = features.ModuleAvailableFeature('termios')
60
62
 
61
63
 
62
64
def _already_unicode(s):
97
99
    return scenarios
98
100
 
99
101
 
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
 
102
load_tests = load_tests_apply_scenarios
107
103
 
108
104
 
109
105
class TestContainsWhitespace(tests.TestCase):
110
106
 
111
107
    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'))
 
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'))
118
114
 
119
115
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
120
116
        # 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'))
 
117
        self.assertFalse(osutils.contains_whitespace(u''))
 
118
        self.assertFalse(osutils.contains_whitespace(u'hellothere'))
 
119
        self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
124
120
 
125
121
 
126
122
class TestRename(tests.TestCaseInTempDir):
140
136
        # This should work everywhere
141
137
        self.create_file('a', 'something in a\n')
142
138
        self._fancy_rename('a', 'b')
143
 
        self.failIfExists('a')
144
 
        self.failUnlessExists('b')
 
139
        self.assertPathDoesNotExist('a')
 
140
        self.assertPathExists('b')
145
141
        self.check_file_contents('b', 'something in a\n')
146
142
 
147
143
        self.create_file('a', 'new something in a\n')
154
150
        self.create_file('target', 'data in target\n')
155
151
        self.assertRaises((IOError, OSError), self._fancy_rename,
156
152
                          'missingsource', 'target')
157
 
        self.failUnlessExists('target')
 
153
        self.assertPathExists('target')
158
154
        self.check_file_contents('target', 'data in target\n')
159
155
 
160
156
    def test_fancy_rename_fails_if_source_and_target_missing(self):
165
161
        # Rename should be semi-atomic on all platforms
166
162
        self.create_file('a', 'something in a\n')
167
163
        osutils.rename('a', 'b')
168
 
        self.failIfExists('a')
169
 
        self.failUnlessExists('b')
 
164
        self.assertPathDoesNotExist('a')
 
165
        self.assertPathExists('b')
170
166
        self.check_file_contents('b', 'something in a\n')
171
167
 
172
168
        self.create_file('a', 'new something in a\n')
184
180
        # we can't use failUnlessExists on case-insensitive filesystem
185
181
        # so try to check shape of the tree
186
182
        shape = sorted(os.listdir('.'))
187
 
        self.assertEquals(['A', 'B'], shape)
 
183
        self.assertEqual(['A', 'B'], shape)
 
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)
188
193
 
189
194
 
190
195
class TestRandChars(tests.TestCase):
217
222
                         (['src'], SRC_FOO_C),
218
223
                         (['src'], 'src'),
219
224
                         ]:
220
 
            self.assert_(osutils.is_inside_any(dirs, fn))
 
225
            self.assertTrue(osutils.is_inside_any(dirs, fn))
221
226
        for dirs, fn in [(['src'], 'srccontrol'),
222
227
                         (['src'], 'srccontrol/foo')]:
223
228
            self.assertFalse(osutils.is_inside_any(dirs, fn))
229
234
                         (['src/bar.c', 'bla/foo.c'], 'src'),
230
235
                         (['src'], 'src'),
231
236
                         ]:
232
 
            self.assert_(osutils.is_inside_or_parent_of_any(dirs, fn))
 
237
            self.assertTrue(osutils.is_inside_or_parent_of_any(dirs, fn))
233
238
 
234
239
        for dirs, fn in [(['src'], 'srccontrol'),
235
240
                         (['srccontrol/foo.c'], 'src'),
237
242
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
238
243
 
239
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
 
240
264
class TestRmTree(tests.TestCaseInTempDir):
241
265
 
242
266
    def test_rmtree(self):
254
278
 
255
279
        osutils.rmtree('dir')
256
280
 
257
 
        self.failIfExists('dir/file')
258
 
        self.failIfExists('dir')
 
281
        self.assertPathDoesNotExist('dir/file')
 
282
        self.assertPathDoesNotExist('dir')
259
283
 
260
284
 
261
285
class TestDeleteAny(tests.TestCaseInTempDir):
274
298
 
275
299
    def test_file_kind(self):
276
300
        self.build_tree(['file', 'dir/'])
277
 
        self.assertEquals('file', osutils.file_kind('file'))
278
 
        self.assertEquals('directory', osutils.file_kind('dir/'))
 
301
        self.assertEqual('file', osutils.file_kind('file'))
 
302
        self.assertEqual('directory', osutils.file_kind('dir/'))
279
303
        if osutils.has_symlinks():
280
304
            os.symlink('symlink', 'symlink')
281
 
            self.assertEquals('symlink', osutils.file_kind('symlink'))
 
305
            self.assertEqual('symlink', osutils.file_kind('symlink'))
282
306
 
283
307
        # TODO: jam 20060529 Test a block device
284
308
        try:
287
311
            if e.errno not in (errno.ENOENT,):
288
312
                raise
289
313
        else:
290
 
            self.assertEquals('chardev', osutils.file_kind('/dev/null'))
 
314
            self.assertEqual('chardev', osutils.file_kind('/dev/null'))
291
315
 
292
316
        mkfifo = getattr(os, 'mkfifo', None)
293
317
        if mkfifo:
294
318
            mkfifo('fifo')
295
319
            try:
296
 
                self.assertEquals('fifo', osutils.file_kind('fifo'))
 
320
                self.assertEqual('fifo', osutils.file_kind('fifo'))
297
321
            finally:
298
322
                os.remove('fifo')
299
323
 
302
326
            s = socket.socket(AF_UNIX)
303
327
            s.bind('socket')
304
328
            try:
305
 
                self.assertEquals('socket', osutils.file_kind('socket'))
 
329
                self.assertEqual('socket', osutils.file_kind('socket'))
306
330
            finally:
307
331
                os.remove('socket')
308
332
 
413
437
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
414
438
 
415
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
 
416
483
class TestLinks(tests.TestCaseInTempDir):
417
484
 
418
485
    def test_dereference_path(self):
419
 
        self.requireFeature(tests.SymlinkFeature)
 
486
        self.requireFeature(features.SymlinkFeature)
420
487
        cwd = osutils.realpath('.')
421
488
        os.mkdir('bar')
422
489
        bar_path = osutils.pathjoin(cwd, 'bar')
469
536
 
470
537
class TestCanonicalRelPath(tests.TestCaseInTempDir):
471
538
 
472
 
    _test_needs_features = [tests.CaseInsCasePresFilenameFeature]
 
539
    _test_needs_features = [features.CaseInsCasePresFilenameFeature]
473
540
 
474
541
    def test_canonical_relpath_simple(self):
475
542
        f = file('MixedCaseName', 'w')
476
543
        f.close()
477
544
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
478
 
        self.failUnlessEqual('work/MixedCaseName', actual)
 
545
        self.assertEqual('work/MixedCaseName', actual)
479
546
 
480
547
    def test_canonical_relpath_missing_tail(self):
481
548
        os.mkdir('MixedCaseParent')
482
549
        actual = osutils.canonical_relpath(self.test_base_dir,
483
550
                                           'mixedcaseparent/nochild')
484
 
        self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
 
551
        self.assertEqual('work/MixedCaseParent/nochild', actual)
485
552
 
486
553
 
487
554
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
531
598
    """Test pumpfile method."""
532
599
 
533
600
    def setUp(self):
534
 
        tests.TestCase.setUp(self)
 
601
        super(TestPumpFile, self).setUp()
535
602
        # create a test datablock
536
603
        self.block_size = 512
537
604
        pattern = '0123456789ABCDEF'
805
872
        self.assertEqual(None, osutils.safe_file_id(None))
806
873
 
807
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
 
808
924
class TestWin32Funcs(tests.TestCase):
809
925
    """Test that _win32 versions of os utilities return appropriate paths."""
810
926
 
811
927
    def test_abspath(self):
 
928
        self.requireFeature(features.win32_feature)
812
929
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
813
930
        self.assertEqual('C:/foo', osutils._win32_abspath('C:/foo'))
814
931
        self.assertEqual('//HOST/path', osutils._win32_abspath(r'\\HOST\path'))
827
944
                         osutils._win32_pathjoin('path/to', 'C:/foo'))
828
945
        self.assertEqual('path/to/foo',
829
946
                         osutils._win32_pathjoin('path/to/', 'foo'))
830
 
        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,
831
954
                         osutils._win32_pathjoin('C:/path/to/', '/foo'))
832
 
        self.assertEqual('/foo',
 
955
        self.assertEqual(expected,
833
956
                         osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
834
957
 
835
958
    def test_normpath(self):
855
978
        self.assertEqual('C:\\foo', osutils._win32_fixdrive('c:\\foo'))
856
979
 
857
980
    def test_win98_abspath(self):
 
981
        self.requireFeature(features.win32_feature)
858
982
        # absolute path
859
983
        self.assertEqual('C:/foo', osutils._win98_abspath('C:\\foo'))
860
984
        self.assertEqual('C:/foo', osutils._win98_abspath('C:/foo'))
875
999
    """Test win32 functions that create files."""
876
1000
 
877
1001
    def test_getcwd(self):
878
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1002
        self.requireFeature(features.UnicodeFilenameFeature)
879
1003
        os.mkdir(u'mu-\xb5')
880
1004
        os.chdir(u'mu-\xb5')
881
1005
        # TODO: jam 20060427 This will probably fail on Mac OSX because
911
1035
        b.close()
912
1036
 
913
1037
        osutils._win32_rename('b', 'a')
914
 
        self.failUnlessExists('a')
915
 
        self.failIfExists('b')
 
1038
        self.assertPathExists('a')
 
1039
        self.assertPathDoesNotExist('b')
916
1040
        self.assertFileEqual('baz\n', 'a')
917
1041
 
918
1042
    def test_rename_missing_file(self):
971
1095
    """Test mac special functions that require directories."""
972
1096
 
973
1097
    def test_getcwd(self):
974
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1098
        self.requireFeature(features.UnicodeFilenameFeature)
975
1099
        os.mkdir(u'B\xe5gfors')
976
1100
        os.chdir(u'B\xe5gfors')
977
1101
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
978
1102
 
979
1103
    def test_getcwd_nonnorm(self):
980
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1104
        self.requireFeature(features.UnicodeFilenameFeature)
981
1105
        # Test that _mac_getcwd() will normalize this path
982
1106
        os.mkdir(u'Ba\u030agfors')
983
1107
        os.chdir(u'Ba\u030agfors')
1072
1196
        if sys.platform == 'win32':
1073
1197
            raise tests.TestNotApplicable(
1074
1198
                "readdir IOError not tested on win32")
 
1199
        self.requireFeature(features.not_running_as_root)
1075
1200
        os.mkdir("test-unreadable")
1076
1201
        os.chmod("test-unreadable", 0000)
1077
1202
        # must chmod it back so that it can be removed
1080
1205
        # (It would be ok if it happened earlier but at the moment it
1081
1206
        # doesn't.)
1082
1207
        e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
1083
 
        self.assertEquals('./test-unreadable', e.filename)
1084
 
        self.assertEquals(errno.EACCES, e.errno)
 
1208
        self.assertEqual('./test-unreadable', e.filename)
 
1209
        self.assertEqual(errno.EACCES, e.errno)
1085
1210
        # Ensure the message contains the file name
1086
1211
        self.assertContainsRe(str(e), "\./test-unreadable")
1087
1212
 
1092
1217
        # are not using the filesystem's encoding
1093
1218
 
1094
1219
        # require a bytestring based filesystem
1095
 
        self.requireFeature(tests.ByteStringNamedFilesystem)
 
1220
        self.requireFeature(features.ByteStringNamedFilesystem)
1096
1221
 
1097
1222
        tree = [
1098
1223
            '.bzr',
1107
1232
 
1108
1233
        # rename the 1file to a latin-1 filename
1109
1234
        os.rename("./1file", "\xe8file")
 
1235
        if "\xe8file" not in os.listdir("."):
 
1236
            self.skip("Lack filesystem that preserves arbitrary bytes")
1110
1237
 
1111
1238
        self._save_platform_info()
1112
1239
        win32utils.winver = None # Avoid the win32 detection code
1190
1317
        self.requireFeature(UTF8DirReaderFeature)
1191
1318
        self._save_platform_info()
1192
1319
        win32utils.winver = None # Avoid the win32 detection code
1193
 
        osutils._fs_enc = 'UTF-8'
1194
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1320
        osutils._fs_enc = 'utf-8'
 
1321
        self.assertDirReaderIs(
 
1322
            UTF8DirReaderFeature.module.UTF8DirReader)
1195
1323
 
1196
1324
    def test_force_walkdirs_utf8_fs_ascii(self):
1197
1325
        self.requireFeature(UTF8DirReaderFeature)
1198
1326
        self._save_platform_info()
1199
1327
        win32utils.winver = None # Avoid the win32 detection code
1200
 
        osutils._fs_enc = 'US-ASCII'
1201
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1202
 
 
1203
 
    def test_force_walkdirs_utf8_fs_ANSI(self):
1204
 
        self.requireFeature(UTF8DirReaderFeature)
1205
 
        self._save_platform_info()
1206
 
        win32utils.winver = None # Avoid the win32 detection code
1207
 
        osutils._fs_enc = 'ANSI_X3.4-1968'
1208
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1328
        osutils._fs_enc = 'ascii'
 
1329
        self.assertDirReaderIs(
 
1330
            UTF8DirReaderFeature.module.UTF8DirReader)
1209
1331
 
1210
1332
    def test_force_walkdirs_utf8_fs_latin1(self):
1211
1333
        self._save_platform_info()
1212
1334
        win32utils.winver = None # Avoid the win32 detection code
1213
 
        osutils._fs_enc = 'latin1'
 
1335
        osutils._fs_enc = 'iso-8859-1'
1214
1336
        self.assertDirReaderIs(osutils.UnicodeDirReader)
1215
1337
 
1216
1338
    def test_force_walkdirs_utf8_nt(self):
1229
1351
 
1230
1352
    def test_unicode_walkdirs(self):
1231
1353
        """Walkdirs should always return unicode paths."""
1232
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1354
        self.requireFeature(features.UnicodeFilenameFeature)
1233
1355
        name0 = u'0file-\xb6'
1234
1356
        name1 = u'1dir-\u062c\u0648'
1235
1357
        name2 = u'2file-\u0633'
1272
1394
 
1273
1395
        The abspath portion might be in unicode or utf-8
1274
1396
        """
1275
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1397
        self.requireFeature(features.UnicodeFilenameFeature)
1276
1398
        name0 = u'0file-\xb6'
1277
1399
        name1 = u'1dir-\u062c\u0648'
1278
1400
        name2 = u'2file-\u0633'
1333
1455
 
1334
1456
        The abspath portion should be in unicode
1335
1457
        """
1336
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1458
        self.requireFeature(features.UnicodeFilenameFeature)
1337
1459
        # Use the unicode reader. TODO: split into driver-and-driven unit
1338
1460
        # tests.
1339
1461
        self._save_platform_info()
1380
1502
 
1381
1503
    def test__walkdirs_utf8_win32readdir(self):
1382
1504
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1383
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1505
        self.requireFeature(features.UnicodeFilenameFeature)
1384
1506
        from bzrlib._walkdirs_win32 import Win32ReadDir
1385
1507
        self._save_platform_info()
1386
1508
        osutils._selected_dir_reader = Win32ReadDir()
1437
1559
    def test__walkdirs_utf_win32_find_file_stat_file(self):
1438
1560
        """make sure our Stat values are valid"""
1439
1561
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1440
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1562
        self.requireFeature(features.UnicodeFilenameFeature)
1441
1563
        from bzrlib._walkdirs_win32 import Win32ReadDir
1442
1564
        name0u = u'0file-\xb6'
1443
1565
        name0 = name0u.encode('utf8')
1461
1583
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
1462
1584
        """make sure our Stat values are valid"""
1463
1585
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1464
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1586
        self.requireFeature(features.UnicodeFilenameFeature)
1465
1587
        from bzrlib._walkdirs_win32 import Win32ReadDir
1466
1588
        name0u = u'0dir-\u062c\u0648'
1467
1589
        name0 = name0u.encode('utf8')
1567
1689
        self.assertEqual(['c'], os.listdir('target/b'))
1568
1690
 
1569
1691
    def test_copy_tree_symlinks(self):
1570
 
        self.requireFeature(tests.SymlinkFeature)
 
1692
        self.requireFeature(features.SymlinkFeature)
1571
1693
        self.build_tree(['source/'])
1572
1694
        os.symlink('a/generic/path', 'source/lnk')
1573
1695
        osutils.copy_tree('source', 'target')
1598
1720
                          ('d', 'source/b', 'target/b'),
1599
1721
                          ('f', 'source/b/c', 'target/b/c'),
1600
1722
                         ], processed_files)
1601
 
        self.failIfExists('target')
 
1723
        self.assertPathDoesNotExist('target')
1602
1724
        if osutils.has_symlinks():
1603
1725
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1604
1726
 
1650
1772
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1651
1773
        self.assertEqual('foo', old)
1652
1774
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1653
 
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
 
1775
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1654
1776
 
1655
1777
 
1656
1778
class TestSizeShaFile(tests.TestCaseInTempDir):
1733
1855
 
1734
1856
class TestDirReader(tests.TestCaseInTempDir):
1735
1857
 
 
1858
    scenarios = dir_reader_scenarios()
 
1859
 
1736
1860
    # Set by load_tests
1737
1861
    _dir_reader_class = None
1738
1862
    _native_to_unicode = None
1739
1863
 
1740
1864
    def setUp(self):
1741
 
        tests.TestCaseInTempDir.setUp(self)
 
1865
        super(TestDirReader, self).setUp()
1742
1866
        self.overrideAttr(osutils,
1743
1867
                          '_selected_dir_reader', self._dir_reader_class())
1744
1868
 
1838
1962
        return filtered_dirblocks
1839
1963
 
1840
1964
    def test_walk_unicode_tree(self):
1841
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1965
        self.requireFeature(features.UnicodeFilenameFeature)
1842
1966
        tree, expected_dirblocks = self._get_unicode_tree()
1843
1967
        self.build_tree(tree)
1844
1968
        result = list(osutils._walkdirs_utf8('.'))
1845
1969
        self.assertEqual(expected_dirblocks, self._filter_out(result))
1846
1970
 
1847
1971
    def test_symlink(self):
1848
 
        self.requireFeature(tests.SymlinkFeature)
1849
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1972
        self.requireFeature(features.SymlinkFeature)
 
1973
        self.requireFeature(features.UnicodeFilenameFeature)
1850
1974
        target = u'target\N{Euro Sign}'
1851
1975
        link_name = u'l\N{Euro Sign}nk'
1852
1976
        os.symlink(target, link_name)
1870
1994
    But prior python versions failed to properly encode the passed unicode
1871
1995
    string.
1872
1996
    """
1873
 
    _test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
 
1997
    _test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
1874
1998
 
1875
1999
    def setUp(self):
1876
2000
        super(tests.TestCaseInTempDir, self).setUp()
1879
2003
        os.symlink(self.target, self.link)
1880
2004
 
1881
2005
    def test_os_readlink_link_encoding(self):
1882
 
        if sys.version_info < (2, 6):
1883
 
            self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
1884
 
        else:
1885
 
            self.assertEquals(self.target,  os.readlink(self.link))
 
2006
        self.assertEqual(self.target,  os.readlink(self.link))
1886
2007
 
1887
2008
    def test_os_readlink_link_decoding(self):
1888
 
        self.assertEquals(self.target.encode(osutils._fs_enc),
 
2009
        self.assertEqual(self.target.encode(osutils._fs_enc),
1889
2010
                          os.readlink(self.link.encode(osutils._fs_enc)))
1890
2011
 
1891
2012
 
1900
2021
        self.assertIsInstance(concurrency, int)
1901
2022
 
1902
2023
    def test_local_concurrency_environment_variable(self):
1903
 
        os.environ['BZR_CONCURRENCY'] = '2'
 
2024
        self.overrideEnv('BZR_CONCURRENCY', '2')
1904
2025
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1905
 
        os.environ['BZR_CONCURRENCY'] = '3'
 
2026
        self.overrideEnv('BZR_CONCURRENCY', '3')
1906
2027
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1907
 
        os.environ['BZR_CONCURRENCY'] = 'foo'
 
2028
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
1908
2029
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1909
2030
 
1910
2031
    def test_option_concurrency(self):
1911
 
        os.environ['BZR_CONCURRENCY'] = '1'
 
2032
        self.overrideEnv('BZR_CONCURRENCY', '1')
1912
2033
        self.run_bzr('rocks --concurrency 42')
1913
 
        # Command line overrides envrionment variable
1914
 
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1915
 
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
 
2034
        # Command line overrides environment variable
 
2035
        self.assertEqual('42', os.environ['BZR_CONCURRENCY'])
 
2036
        self.assertEqual(42, osutils.local_concurrency(use_cache=False))
1916
2037
 
1917
2038
 
1918
2039
class TestFailedToLoadExtension(tests.TestCase):
1931
2052
    def test_failure_to_load(self):
1932
2053
        self._try_loading()
1933
2054
        self.assertLength(1, osutils._extension_load_failures)
1934
 
        self.assertEquals(osutils._extension_load_failures[0],
 
2055
        self.assertEqual(osutils._extension_load_failures[0],
1935
2056
            "No module named _fictional_extension_py")
1936
2057
 
1937
2058
    def test_report_extension_load_failures_no_warning(self):
1955
2076
class TestTerminalWidth(tests.TestCase):
1956
2077
 
1957
2078
    def setUp(self):
1958
 
        tests.TestCase.setUp(self)
 
2079
        super(TestTerminalWidth, self).setUp()
1959
2080
        self._orig_terminal_size_state = osutils._terminal_size_state
1960
2081
        self._orig_first_terminal_size = osutils._first_terminal_size
1961
2082
        self.addCleanup(self.restore_osutils_globals)
1986
2107
    def test_defaults_to_BZR_COLUMNS(self):
1987
2108
        # BZR_COLUMNS is set by the test framework
1988
2109
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
1989
 
        os.environ['BZR_COLUMNS'] = '12'
 
2110
        self.overrideEnv('BZR_COLUMNS', '12')
1990
2111
        self.assertEqual(12, osutils.terminal_width())
1991
2112
 
 
2113
    def test_BZR_COLUMNS_0_no_limit(self):
 
2114
        self.overrideEnv('BZR_COLUMNS', '0')
 
2115
        self.assertEqual(None, osutils.terminal_width())
 
2116
 
1992
2117
    def test_falls_back_to_COLUMNS(self):
1993
 
        del os.environ['BZR_COLUMNS']
 
2118
        self.overrideEnv('BZR_COLUMNS', None)
1994
2119
        self.assertNotEqual('42', os.environ['COLUMNS'])
1995
2120
        self.set_fake_tty()
1996
 
        os.environ['COLUMNS'] = '42'
 
2121
        self.overrideEnv('COLUMNS', '42')
1997
2122
        self.assertEqual(42, osutils.terminal_width())
1998
2123
 
1999
2124
    def test_tty_default_without_columns(self):
2000
 
        del os.environ['BZR_COLUMNS']
2001
 
        del os.environ['COLUMNS']
 
2125
        self.overrideEnv('BZR_COLUMNS', None)
 
2126
        self.overrideEnv('COLUMNS', None)
2002
2127
 
2003
2128
        def terminal_size(w, h):
2004
2129
            return 42, 42
2011
2136
        self.assertEqual(42, osutils.terminal_width())
2012
2137
 
2013
2138
    def test_non_tty_default_without_columns(self):
2014
 
        del os.environ['BZR_COLUMNS']
2015
 
        del os.environ['COLUMNS']
 
2139
        self.overrideEnv('BZR_COLUMNS', None)
 
2140
        self.overrideEnv('COLUMNS', None)
2016
2141
        self.replace_stdout(None)
2017
2142
        self.assertEqual(None, osutils.terminal_width())
2018
2143
 
2028
2153
        else:
2029
2154
            self.overrideAttr(termios, 'TIOCGWINSZ')
2030
2155
            del termios.TIOCGWINSZ
2031
 
        del os.environ['BZR_COLUMNS']
2032
 
        del os.environ['COLUMNS']
 
2156
        self.overrideEnv('BZR_COLUMNS', None)
 
2157
        self.overrideEnv('COLUMNS', None)
2033
2158
        # Whatever the result is, if we don't raise an exception, it's ok.
2034
2159
        osutils.terminal_width()
2035
2160
 
 
2161
 
2036
2162
class TestCreationOps(tests.TestCaseInTempDir):
2037
2163
    _test_needs_features = [features.chown_feature]
2038
2164
 
2039
2165
    def setUp(self):
2040
 
        tests.TestCaseInTempDir.setUp(self)
 
2166
        super(TestCreationOps, self).setUp()
2041
2167
        self.overrideAttr(os, 'chown', self._dummy_chown)
2042
2168
 
2043
2169
        # params set by call to _dummy_chown
2053
2179
        osutils.copy_ownership_from_path('test_file', ownsrc)
2054
2180
 
2055
2181
        s = os.stat(ownsrc)
2056
 
        self.assertEquals(self.path, 'test_file')
2057
 
        self.assertEquals(self.uid, s.st_uid)
2058
 
        self.assertEquals(self.gid, s.st_gid)
 
2182
        self.assertEqual(self.path, 'test_file')
 
2183
        self.assertEqual(self.uid, s.st_uid)
 
2184
        self.assertEqual(self.gid, s.st_gid)
2059
2185
 
2060
2186
    def test_copy_ownership_nonesrc(self):
2061
2187
        """copy_ownership_from_path test with src=None."""
2064
2190
        osutils.copy_ownership_from_path('test_file')
2065
2191
 
2066
2192
        s = os.stat('..')
2067
 
        self.assertEquals(self.path, 'test_file')
2068
 
        self.assertEquals(self.uid, s.st_uid)
2069
 
        self.assertEquals(self.gid, s.st_gid)
 
2193
        self.assertEqual(self.path, 'test_file')
 
2194
        self.assertEqual(self.uid, s.st_uid)
 
2195
        self.assertEqual(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
 
2070
2254
 
2071
2255
class TestGetuserUnicode(tests.TestCase):
2072
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
 
2073
2268
    def test_ascii_user(self):
2074
 
        osutils.set_or_unset_env('LOGNAME', 'jrandom')
 
2269
        self.overrideEnv(self.envvar_to_override(), 'jrandom')
2075
2270
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
2076
2271
 
2077
2272
    def test_unicode_user(self):
2078
2273
        ue = osutils.get_user_encoding()
2079
 
        osutils.set_or_unset_env('LOGNAME', u'jrandom\xb6'.encode(ue))
2080
 
        self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
 
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")))