~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-27 13:36:17 UTC
  • mto: This revision was merged to the branch mainline in revision 6614.
  • Revision ID: v.ladeuil+lp@free.fr-20160127133617-gteit32e0nu3938n
Use ssl module for the match_hostname function

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for the osutils wrapper."""
18
18
 
 
19
from cStringIO import StringIO
19
20
import errno
20
21
import os
 
22
import re
 
23
import select
21
24
import socket
22
 
import stat
23
25
import sys
 
26
import tempfile
 
27
import time
24
28
 
25
 
import bzrlib
26
29
from bzrlib import (
27
30
    errors,
 
31
    lazy_regex,
28
32
    osutils,
 
33
    symbol_versioning,
 
34
    tests,
 
35
    trace,
29
36
    win32utils,
30
37
    )
31
 
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
32
38
from bzrlib.tests import (
33
 
        StringIOWrapper,
34
 
        TestCase, 
35
 
        TestCaseInTempDir, 
36
 
        TestSkipped,
37
 
        )
38
 
 
39
 
 
40
 
class TestOSUtils(TestCaseInTempDir):
 
39
    features,
 
40
    file_utils,
 
41
    test__walkdirs_win32,
 
42
    )
 
43
from bzrlib.tests.scenarios import load_tests_apply_scenarios
 
44
 
 
45
 
 
46
class _UTF8DirReaderFeature(features.Feature):
 
47
 
 
48
    def _probe(self):
 
49
        try:
 
50
            from bzrlib import _readdir_pyx
 
51
            self.reader = _readdir_pyx.UTF8DirReader
 
52
            return True
 
53
        except ImportError:
 
54
            return False
 
55
 
 
56
    def feature_name(self):
 
57
        return 'bzrlib._readdir_pyx'
 
58
 
 
59
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
 
60
 
 
61
term_ios_feature = features.ModuleAvailableFeature('termios')
 
62
 
 
63
 
 
64
def _already_unicode(s):
 
65
    return s
 
66
 
 
67
 
 
68
def _utf8_to_unicode(s):
 
69
    return s.decode('UTF-8')
 
70
 
 
71
 
 
72
def dir_reader_scenarios():
 
73
    # For each dir reader we define:
 
74
 
 
75
    # - native_to_unicode: a function converting the native_abspath as returned
 
76
    #   by DirReader.read_dir to its unicode representation
 
77
 
 
78
    # UnicodeDirReader is the fallback, it should be tested on all platforms.
 
79
    scenarios = [('unicode',
 
80
                  dict(_dir_reader_class=osutils.UnicodeDirReader,
 
81
                       _native_to_unicode=_already_unicode))]
 
82
    # Some DirReaders are platform specific and even there they may not be
 
83
    # available.
 
84
    if UTF8DirReaderFeature.available():
 
85
        from bzrlib import _readdir_pyx
 
86
        scenarios.append(('utf8',
 
87
                          dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
 
88
                               _native_to_unicode=_utf8_to_unicode)))
 
89
 
 
90
    if test__walkdirs_win32.win32_readdir_feature.available():
 
91
        try:
 
92
            from bzrlib import _walkdirs_win32
 
93
            scenarios.append(
 
94
                ('win32',
 
95
                 dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
 
96
                      _native_to_unicode=_already_unicode)))
 
97
        except ImportError:
 
98
            pass
 
99
    return scenarios
 
100
 
 
101
 
 
102
load_tests = load_tests_apply_scenarios
 
103
 
 
104
 
 
105
class TestContainsWhitespace(tests.TestCase):
41
106
 
42
107
    def test_contains_whitespace(self):
43
 
        self.failUnless(osutils.contains_whitespace(u' '))
44
 
        self.failUnless(osutils.contains_whitespace(u'hello there'))
45
 
        self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
46
 
        self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
47
 
        self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
48
 
        self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
 
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'))
49
114
 
50
115
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
51
116
        # is whitespace, but we do not.
52
 
        self.failIf(osutils.contains_whitespace(u''))
53
 
        self.failIf(osutils.contains_whitespace(u'hellothere'))
54
 
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
 
117
        self.assertFalse(osutils.contains_whitespace(u''))
 
118
        self.assertFalse(osutils.contains_whitespace(u'hellothere'))
 
119
        self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
 
120
 
 
121
 
 
122
class TestRename(tests.TestCaseInTempDir):
 
123
 
 
124
    def create_file(self, filename, content):
 
125
        f = open(filename, 'wb')
 
126
        try:
 
127
            f.write(content)
 
128
        finally:
 
129
            f.close()
 
130
 
 
131
    def _fancy_rename(self, a, b):
 
132
        osutils.fancy_rename(a, b, rename_func=os.rename,
 
133
                             unlink_func=os.unlink)
55
134
 
56
135
    def test_fancy_rename(self):
57
136
        # This should work everywhere
58
 
        def rename(a, b):
59
 
            osutils.fancy_rename(a, b,
60
 
                    rename_func=os.rename,
61
 
                    unlink_func=os.unlink)
62
 
 
63
 
        open('a', 'wb').write('something in a\n')
64
 
        rename('a', 'b')
65
 
        self.failIfExists('a')
66
 
        self.failUnlessExists('b')
 
137
        self.create_file('a', 'something in a\n')
 
138
        self._fancy_rename('a', 'b')
 
139
        self.assertPathDoesNotExist('a')
 
140
        self.assertPathExists('b')
67
141
        self.check_file_contents('b', 'something in a\n')
68
142
 
69
 
        open('a', 'wb').write('new something in a\n')
70
 
        rename('b', 'a')
 
143
        self.create_file('a', 'new something in a\n')
 
144
        self._fancy_rename('b', 'a')
71
145
 
72
146
        self.check_file_contents('a', 'something in a\n')
73
147
 
 
148
    def test_fancy_rename_fails_source_missing(self):
 
149
        # An exception should be raised, and the target should be left in place
 
150
        self.create_file('target', 'data in target\n')
 
151
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
152
                          'missingsource', 'target')
 
153
        self.assertPathExists('target')
 
154
        self.check_file_contents('target', 'data in target\n')
 
155
 
 
156
    def test_fancy_rename_fails_if_source_and_target_missing(self):
 
157
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
158
                          'missingsource', 'missingtarget')
 
159
 
74
160
    def test_rename(self):
75
161
        # Rename should be semi-atomic on all platforms
76
 
        open('a', 'wb').write('something in a\n')
 
162
        self.create_file('a', 'something in a\n')
77
163
        osutils.rename('a', 'b')
78
 
        self.failIfExists('a')
79
 
        self.failUnlessExists('b')
 
164
        self.assertPathDoesNotExist('a')
 
165
        self.assertPathExists('b')
80
166
        self.check_file_contents('b', 'something in a\n')
81
167
 
82
 
        open('a', 'wb').write('new something in a\n')
 
168
        self.create_file('a', 'new something in a\n')
83
169
        osutils.rename('b', 'a')
84
170
 
85
171
        self.check_file_contents('a', 'something in a\n')
86
172
 
87
173
    # TODO: test fancy_rename using a MemoryTransport
88
174
 
 
175
    def test_rename_change_case(self):
 
176
        # on Windows we should be able to change filename case by rename
 
177
        self.build_tree(['a', 'b/'])
 
178
        osutils.rename('a', 'A')
 
179
        osutils.rename('b', 'B')
 
180
        # we can't use failUnlessExists on case-insensitive filesystem
 
181
        # so try to check shape of the tree
 
182
        shape = sorted(os.listdir('.'))
 
183
        self.assertEquals(['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)
 
193
 
 
194
 
 
195
class TestRandChars(tests.TestCase):
 
196
 
89
197
    def test_01_rand_chars_empty(self):
90
198
        result = osutils.rand_chars(0)
91
199
        self.assertEqual(result, '')
96
204
        self.assertEqual(type(result), str)
97
205
        self.assertContainsRe(result, r'^[a-z0-9]{100}$')
98
206
 
 
207
 
 
208
class TestIsInside(tests.TestCase):
 
209
 
99
210
    def test_is_inside(self):
100
211
        is_inside = osutils.is_inside
101
212
        self.assertTrue(is_inside('src', 'src/foo.c'))
105
216
        self.assertFalse(is_inside('foo.c', ''))
106
217
        self.assertTrue(is_inside('', 'foo.c'))
107
218
 
 
219
    def test_is_inside_any(self):
 
220
        SRC_FOO_C = osutils.pathjoin('src', 'foo.c')
 
221
        for dirs, fn in [(['src', 'doc'], SRC_FOO_C),
 
222
                         (['src'], SRC_FOO_C),
 
223
                         (['src'], 'src'),
 
224
                         ]:
 
225
            self.assert_(osutils.is_inside_any(dirs, fn))
 
226
        for dirs, fn in [(['src'], 'srccontrol'),
 
227
                         (['src'], 'srccontrol/foo')]:
 
228
            self.assertFalse(osutils.is_inside_any(dirs, fn))
 
229
 
 
230
    def test_is_inside_or_parent_of_any(self):
 
231
        for dirs, fn in [(['src', 'doc'], 'src/foo.c'),
 
232
                         (['src'], 'src/foo.c'),
 
233
                         (['src/bar.c'], 'src'),
 
234
                         (['src/bar.c', 'bla/foo.c'], 'src'),
 
235
                         (['src'], 'src'),
 
236
                         ]:
 
237
            self.assert_(osutils.is_inside_or_parent_of_any(dirs, fn))
 
238
 
 
239
        for dirs, fn in [(['src'], 'srccontrol'),
 
240
                         (['srccontrol/foo.c'], 'src'),
 
241
                         (['src'], 'srccontrol/foo')]:
 
242
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
 
243
 
 
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
 
 
264
class TestRmTree(tests.TestCaseInTempDir):
 
265
 
108
266
    def test_rmtree(self):
109
267
        # Check to remove tree with read-only files/dirs
110
268
        os.mkdir('dir')
120
278
 
121
279
        osutils.rmtree('dir')
122
280
 
123
 
        self.failIfExists('dir/file')
124
 
        self.failIfExists('dir')
 
281
        self.assertPathDoesNotExist('dir/file')
 
282
        self.assertPathDoesNotExist('dir')
 
283
 
 
284
 
 
285
class TestDeleteAny(tests.TestCaseInTempDir):
 
286
 
 
287
    def test_delete_any_readonly(self):
 
288
        # from <https://bugs.launchpad.net/bzr/+bug/218206>
 
289
        self.build_tree(['d/', 'f'])
 
290
        osutils.make_readonly('d')
 
291
        osutils.make_readonly('f')
 
292
 
 
293
        osutils.delete_any('f')
 
294
        osutils.delete_any('d')
 
295
 
 
296
 
 
297
class TestKind(tests.TestCaseInTempDir):
125
298
 
126
299
    def test_file_kind(self):
127
300
        self.build_tree(['file', 'dir/'])
130
303
        if osutils.has_symlinks():
131
304
            os.symlink('symlink', 'symlink')
132
305
            self.assertEquals('symlink', osutils.file_kind('symlink'))
133
 
        
 
306
 
134
307
        # TODO: jam 20060529 Test a block device
135
308
        try:
136
309
            os.lstat('/dev/null')
157
330
            finally:
158
331
                os.remove('socket')
159
332
 
 
333
    def test_kind_marker(self):
 
334
        self.assertEqual("", osutils.kind_marker("file"))
 
335
        self.assertEqual("/", osutils.kind_marker('directory'))
 
336
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
 
337
        self.assertEqual("@", osutils.kind_marker("symlink"))
 
338
        self.assertEqual("+", osutils.kind_marker("tree-reference"))
 
339
        self.assertEqual("", osutils.kind_marker("fifo"))
 
340
        self.assertEqual("", osutils.kind_marker("socket"))
 
341
        self.assertEqual("", osutils.kind_marker("unknown"))
 
342
 
 
343
 
 
344
class TestUmask(tests.TestCaseInTempDir):
 
345
 
160
346
    def test_get_umask(self):
161
347
        if sys.platform == 'win32':
162
348
            # umask always returns '0', no way to set it
164
350
            return
165
351
 
166
352
        orig_umask = osutils.get_umask()
167
 
        try:
168
 
            os.umask(0222)
169
 
            self.assertEqual(0222, osutils.get_umask())
170
 
            os.umask(0022)
171
 
            self.assertEqual(0022, osutils.get_umask())
172
 
            os.umask(0002)
173
 
            self.assertEqual(0002, osutils.get_umask())
174
 
            os.umask(0027)
175
 
            self.assertEqual(0027, osutils.get_umask())
176
 
        finally:
177
 
            os.umask(orig_umask)
 
353
        self.addCleanup(os.umask, orig_umask)
 
354
        os.umask(0222)
 
355
        self.assertEqual(0222, osutils.get_umask())
 
356
        os.umask(0022)
 
357
        self.assertEqual(0022, osutils.get_umask())
 
358
        os.umask(0002)
 
359
        self.assertEqual(0002, osutils.get_umask())
 
360
        os.umask(0027)
 
361
        self.assertEqual(0027, osutils.get_umask())
 
362
 
 
363
 
 
364
class TestDateTime(tests.TestCase):
178
365
 
179
366
    def assertFormatedDelta(self, expected, seconds):
180
367
        """Assert osutils.format_delta formats as expected"""
212
399
        self.assertFormatedDelta('1 second in the future', -1)
213
400
        self.assertFormatedDelta('2 seconds in the future', -2)
214
401
 
 
402
    def test_format_date(self):
 
403
        self.assertRaises(errors.UnsupportedTimezoneFormat,
 
404
            osutils.format_date, 0, timezone='foo')
 
405
        self.assertIsInstance(osutils.format_date(0), str)
 
406
        self.assertIsInstance(osutils.format_local_date(0), unicode)
 
407
        # Testing for the actual value of the local weekday without
 
408
        # duplicating the code from format_date is difficult.
 
409
        # Instead blackbox.test_locale should check for localized
 
410
        # dates once they do occur in output strings.
 
411
 
 
412
    def test_format_date_with_offset_in_original_timezone(self):
 
413
        self.assertEqual("Thu 1970-01-01 00:00:00 +0000",
 
414
            osutils.format_date_with_offset_in_original_timezone(0))
 
415
        self.assertEqual("Fri 1970-01-02 03:46:40 +0000",
 
416
            osutils.format_date_with_offset_in_original_timezone(100000))
 
417
        self.assertEqual("Fri 1970-01-02 05:46:40 +0200",
 
418
            osutils.format_date_with_offset_in_original_timezone(100000, 7200))
 
419
 
 
420
    def test_local_time_offset(self):
 
421
        """Test that local_time_offset() returns a sane value."""
 
422
        offset = osutils.local_time_offset()
 
423
        self.assertTrue(isinstance(offset, int))
 
424
        # Test that the offset is no more than a eighteen hours in
 
425
        # either direction.
 
426
        # Time zone handling is system specific, so it is difficult to
 
427
        # do more specific tests, but a value outside of this range is
 
428
        # probably wrong.
 
429
        eighteen_hours = 18 * 3600
 
430
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
431
 
 
432
    def test_local_time_offset_with_timestamp(self):
 
433
        """Test that local_time_offset() works with a timestamp."""
 
434
        offset = osutils.local_time_offset(1000000000.1234567)
 
435
        self.assertTrue(isinstance(offset, int))
 
436
        eighteen_hours = 18 * 3600
 
437
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
438
 
 
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
 
 
483
class TestLinks(tests.TestCaseInTempDir):
 
484
 
215
485
    def test_dereference_path(self):
216
 
        if not osutils.has_symlinks():
217
 
            raise TestSkipped('Symlinks are not supported on this platform')
 
486
        self.requireFeature(features.SymlinkFeature)
218
487
        cwd = osutils.realpath('.')
219
488
        os.mkdir('bar')
220
489
        bar_path = osutils.pathjoin(cwd, 'bar')
223
492
        self.assertEqual(bar_path, osutils.realpath('./bar'))
224
493
        os.symlink('bar', 'foo')
225
494
        self.assertEqual(bar_path, osutils.realpath('./foo'))
226
 
        
 
495
 
227
496
        # Does not dereference terminal symlinks
228
497
        foo_path = osutils.pathjoin(cwd, 'foo')
229
498
        self.assertEqual(foo_path, osutils.dereference_path('./foo'))
240
509
        foo_baz_path = osutils.pathjoin(foo_path, 'baz')
241
510
        self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
242
511
 
243
 
 
244
 
class TestSafeUnicode(TestCase):
 
512
    def test_changing_access(self):
 
513
        f = file('file', 'w')
 
514
        f.write('monkey')
 
515
        f.close()
 
516
 
 
517
        # Make a file readonly
 
518
        osutils.make_readonly('file')
 
519
        mode = os.lstat('file').st_mode
 
520
        self.assertEqual(mode, mode & 0777555)
 
521
 
 
522
        # Make a file writable
 
523
        osutils.make_writable('file')
 
524
        mode = os.lstat('file').st_mode
 
525
        self.assertEqual(mode, mode | 0200)
 
526
 
 
527
        if osutils.has_symlinks():
 
528
            # should not error when handed a symlink
 
529
            os.symlink('nonexistent', 'dangling')
 
530
            osutils.make_readonly('dangling')
 
531
            osutils.make_writable('dangling')
 
532
 
 
533
    def test_host_os_dereferences_symlinks(self):
 
534
        osutils.host_os_dereferences_symlinks()
 
535
 
 
536
 
 
537
class TestCanonicalRelPath(tests.TestCaseInTempDir):
 
538
 
 
539
    _test_needs_features = [features.CaseInsCasePresFilenameFeature]
 
540
 
 
541
    def test_canonical_relpath_simple(self):
 
542
        f = file('MixedCaseName', 'w')
 
543
        f.close()
 
544
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
 
545
        self.assertEqual('work/MixedCaseName', actual)
 
546
 
 
547
    def test_canonical_relpath_missing_tail(self):
 
548
        os.mkdir('MixedCaseParent')
 
549
        actual = osutils.canonical_relpath(self.test_base_dir,
 
550
                                           'mixedcaseparent/nochild')
 
551
        self.assertEqual('work/MixedCaseParent/nochild', actual)
 
552
 
 
553
 
 
554
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
 
555
 
 
556
    def assertRelpath(self, expected, base, path):
 
557
        actual = osutils._cicp_canonical_relpath(base, path)
 
558
        self.assertEqual(expected, actual)
 
559
 
 
560
    def test_simple(self):
 
561
        self.build_tree(['MixedCaseName'])
 
562
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
563
        self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
 
564
 
 
565
    def test_subdir_missing_tail(self):
 
566
        self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
 
567
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
568
        self.assertRelpath('MixedCaseParent/a_child', base,
 
569
                           'MixedCaseParent/a_child')
 
570
        self.assertRelpath('MixedCaseParent/a_child', base,
 
571
                           'MixedCaseParent/A_Child')
 
572
        self.assertRelpath('MixedCaseParent/not_child', base,
 
573
                           'MixedCaseParent/not_child')
 
574
 
 
575
    def test_at_root_slash(self):
 
576
        # We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
 
577
        # check...
 
578
        if osutils.MIN_ABS_PATHLENGTH > 1:
 
579
            raise tests.TestSkipped('relpath requires %d chars'
 
580
                                    % osutils.MIN_ABS_PATHLENGTH)
 
581
        self.assertRelpath('foo', '/', '/foo')
 
582
 
 
583
    def test_at_root_drive(self):
 
584
        if sys.platform != 'win32':
 
585
            raise tests.TestNotApplicable('we can only test drive-letter relative'
 
586
                                          ' paths on Windows where we have drive'
 
587
                                          ' letters.')
 
588
        # see bug #322807
 
589
        # The specific issue is that when at the root of a drive, 'abspath'
 
590
        # returns "C:/" or just "/". However, the code assumes that abspath
 
591
        # always returns something like "C:/foo" or "/foo" (no trailing slash).
 
592
        self.assertRelpath('foo', 'C:/', 'C:/foo')
 
593
        self.assertRelpath('foo', 'X:/', 'X:/foo')
 
594
        self.assertRelpath('foo', 'X:/', 'X://foo')
 
595
 
 
596
 
 
597
class TestPumpFile(tests.TestCase):
 
598
    """Test pumpfile method."""
 
599
 
 
600
    def setUp(self):
 
601
        super(TestPumpFile, self).setUp()
 
602
        # create a test datablock
 
603
        self.block_size = 512
 
604
        pattern = '0123456789ABCDEF'
 
605
        self.test_data = pattern * (3 * self.block_size / len(pattern))
 
606
        self.test_data_len = len(self.test_data)
 
607
 
 
608
    def test_bracket_block_size(self):
 
609
        """Read data in blocks with the requested read size bracketing the
 
610
        block size."""
 
611
        # make sure test data is larger than max read size
 
612
        self.assertTrue(self.test_data_len > self.block_size)
 
613
 
 
614
        from_file = file_utils.FakeReadFile(self.test_data)
 
615
        to_file = StringIO()
 
616
 
 
617
        # read (max / 2) bytes and verify read size wasn't affected
 
618
        num_bytes_to_read = self.block_size / 2
 
619
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
620
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
 
621
        self.assertEqual(from_file.get_read_count(), 1)
 
622
 
 
623
        # read (max) bytes and verify read size wasn't affected
 
624
        num_bytes_to_read = self.block_size
 
625
        from_file.reset_read_count()
 
626
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
627
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
 
628
        self.assertEqual(from_file.get_read_count(), 1)
 
629
 
 
630
        # read (max + 1) bytes and verify read size was limited
 
631
        num_bytes_to_read = self.block_size + 1
 
632
        from_file.reset_read_count()
 
633
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
634
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
635
        self.assertEqual(from_file.get_read_count(), 2)
 
636
 
 
637
        # finish reading the rest of the data
 
638
        num_bytes_to_read = self.test_data_len - to_file.tell()
 
639
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
640
 
 
641
        # report error if the data wasn't equal (we only report the size due
 
642
        # to the length of the data)
 
643
        response_data = to_file.getvalue()
 
644
        if response_data != self.test_data:
 
645
            message = "Data not equal.  Expected %d bytes, received %d."
 
646
            self.fail(message % (len(response_data), self.test_data_len))
 
647
 
 
648
    def test_specified_size(self):
 
649
        """Request a transfer larger than the maximum block size and verify
 
650
        that the maximum read doesn't exceed the block_size."""
 
651
        # make sure test data is larger than max read size
 
652
        self.assertTrue(self.test_data_len > self.block_size)
 
653
 
 
654
        # retrieve data in blocks
 
655
        from_file = file_utils.FakeReadFile(self.test_data)
 
656
        to_file = StringIO()
 
657
        osutils.pumpfile(from_file, to_file, self.test_data_len,
 
658
                         self.block_size)
 
659
 
 
660
        # verify read size was equal to the maximum read size
 
661
        self.assertTrue(from_file.get_max_read_size() > 0)
 
662
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
663
        self.assertEqual(from_file.get_read_count(), 3)
 
664
 
 
665
        # report error if the data wasn't equal (we only report the size due
 
666
        # to the length of the data)
 
667
        response_data = to_file.getvalue()
 
668
        if response_data != self.test_data:
 
669
            message = "Data not equal.  Expected %d bytes, received %d."
 
670
            self.fail(message % (len(response_data), self.test_data_len))
 
671
 
 
672
    def test_to_eof(self):
 
673
        """Read to end-of-file and verify that the reads are not larger than
 
674
        the maximum read size."""
 
675
        # make sure test data is larger than max read size
 
676
        self.assertTrue(self.test_data_len > self.block_size)
 
677
 
 
678
        # retrieve data to EOF
 
679
        from_file = file_utils.FakeReadFile(self.test_data)
 
680
        to_file = StringIO()
 
681
        osutils.pumpfile(from_file, to_file, -1, self.block_size)
 
682
 
 
683
        # verify read size was equal to the maximum read size
 
684
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
685
        self.assertEqual(from_file.get_read_count(), 4)
 
686
 
 
687
        # report error if the data wasn't equal (we only report the size due
 
688
        # to the length of the data)
 
689
        response_data = to_file.getvalue()
 
690
        if response_data != self.test_data:
 
691
            message = "Data not equal.  Expected %d bytes, received %d."
 
692
            self.fail(message % (len(response_data), self.test_data_len))
 
693
 
 
694
    def test_defaults(self):
 
695
        """Verifies that the default arguments will read to EOF -- this
 
696
        test verifies that any existing usages of pumpfile will not be broken
 
697
        with this new version."""
 
698
        # retrieve data using default (old) pumpfile method
 
699
        from_file = file_utils.FakeReadFile(self.test_data)
 
700
        to_file = StringIO()
 
701
        osutils.pumpfile(from_file, to_file)
 
702
 
 
703
        # report error if the data wasn't equal (we only report the size due
 
704
        # to the length of the data)
 
705
        response_data = to_file.getvalue()
 
706
        if response_data != self.test_data:
 
707
            message = "Data not equal.  Expected %d bytes, received %d."
 
708
            self.fail(message % (len(response_data), self.test_data_len))
 
709
 
 
710
    def test_report_activity(self):
 
711
        activity = []
 
712
        def log_activity(length, direction):
 
713
            activity.append((length, direction))
 
714
        from_file = StringIO(self.test_data)
 
715
        to_file = StringIO()
 
716
        osutils.pumpfile(from_file, to_file, buff_size=500,
 
717
                         report_activity=log_activity, direction='read')
 
718
        self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
 
719
                          (36, 'read')], activity)
 
720
 
 
721
        from_file = StringIO(self.test_data)
 
722
        to_file = StringIO()
 
723
        del activity[:]
 
724
        osutils.pumpfile(from_file, to_file, buff_size=500,
 
725
                         report_activity=log_activity, direction='write')
 
726
        self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
 
727
                          (36, 'write')], activity)
 
728
 
 
729
        # And with a limited amount of data
 
730
        from_file = StringIO(self.test_data)
 
731
        to_file = StringIO()
 
732
        del activity[:]
 
733
        osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
 
734
                         report_activity=log_activity, direction='read')
 
735
        self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
 
736
 
 
737
 
 
738
 
 
739
class TestPumpStringFile(tests.TestCase):
 
740
 
 
741
    def test_empty(self):
 
742
        output = StringIO()
 
743
        osutils.pump_string_file("", output)
 
744
        self.assertEqual("", output.getvalue())
 
745
 
 
746
    def test_more_than_segment_size(self):
 
747
        output = StringIO()
 
748
        osutils.pump_string_file("123456789", output, 2)
 
749
        self.assertEqual("123456789", output.getvalue())
 
750
 
 
751
    def test_segment_size(self):
 
752
        output = StringIO()
 
753
        osutils.pump_string_file("12", output, 2)
 
754
        self.assertEqual("12", output.getvalue())
 
755
 
 
756
    def test_segment_size_multiple(self):
 
757
        output = StringIO()
 
758
        osutils.pump_string_file("1234", output, 2)
 
759
        self.assertEqual("1234", output.getvalue())
 
760
 
 
761
 
 
762
class TestRelpath(tests.TestCase):
 
763
 
 
764
    def test_simple_relpath(self):
 
765
        cwd = osutils.getcwd()
 
766
        subdir = cwd + '/subdir'
 
767
        self.assertEqual('subdir', osutils.relpath(cwd, subdir))
 
768
 
 
769
    def test_deep_relpath(self):
 
770
        cwd = osutils.getcwd()
 
771
        subdir = cwd + '/sub/subsubdir'
 
772
        self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
 
773
 
 
774
    def test_not_relative(self):
 
775
        self.assertRaises(errors.PathNotChild,
 
776
                          osutils.relpath, 'C:/path', 'H:/path')
 
777
        self.assertRaises(errors.PathNotChild,
 
778
                          osutils.relpath, 'C:/', 'H:/path')
 
779
 
 
780
 
 
781
class TestSafeUnicode(tests.TestCase):
245
782
 
246
783
    def test_from_ascii_string(self):
247
784
        self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
256
793
        self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
257
794
 
258
795
    def test_bad_utf8_string(self):
259
 
        self.assertRaises(BzrBadParameterNotUnicode,
 
796
        self.assertRaises(errors.BzrBadParameterNotUnicode,
260
797
                          osutils.safe_unicode,
261
798
                          '\xbb\xbb')
262
799
 
263
800
 
264
 
class TestSafeUtf8(TestCase):
 
801
class TestSafeUtf8(tests.TestCase):
265
802
 
266
803
    def test_from_ascii_string(self):
267
804
        f = 'foobar'
277
814
        self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
278
815
 
279
816
    def test_bad_utf8_string(self):
280
 
        self.assertRaises(BzrBadParameterNotUnicode,
 
817
        self.assertRaises(errors.BzrBadParameterNotUnicode,
281
818
                          osutils.safe_utf8, '\xbb\xbb')
282
819
 
283
820
 
284
 
class TestSafeRevisionId(TestCase):
 
821
class TestSafeRevisionId(tests.TestCase):
285
822
 
286
823
    def test_from_ascii_string(self):
287
 
        f = 'foobar'
288
 
        self.assertEqual('foobar', osutils.safe_revision_id(f))
289
 
        self.assertIs(osutils.safe_utf8(f), f)
 
824
        # this shouldn't give a warning because it's getting an ascii string
 
825
        self.assertEqual('foobar', osutils.safe_revision_id('foobar'))
290
826
 
291
827
    def test_from_unicode_string_ascii_contents(self):
292
 
        self.assertEqual('bargam', osutils.safe_revision_id(u'bargam'))
 
828
        self.assertEqual('bargam',
 
829
                         osutils.safe_revision_id(u'bargam', warn=False))
 
830
 
 
831
    def test_from_unicode_deprecated(self):
 
832
        self.assertEqual('bargam',
 
833
            self.callDeprecated([osutils._revision_id_warning],
 
834
                                osutils.safe_revision_id, u'bargam'))
293
835
 
294
836
    def test_from_unicode_string_unicode_contents(self):
295
837
        self.assertEqual('bargam\xc2\xae',
296
 
                         osutils.safe_revision_id(u'bargam\xae'))
 
838
                         osutils.safe_revision_id(u'bargam\xae', warn=False))
297
839
 
298
840
    def test_from_utf8_string(self):
299
841
        self.assertEqual('foo\xc2\xae',
300
842
                         osutils.safe_revision_id('foo\xc2\xae'))
301
843
 
302
 
    def test_bad_utf8_string(self):
303
 
        # This check may eventually go away
304
 
        self.assertRaises(BzrBadParameterNotUnicode,
305
 
                          osutils.safe_revision_id, '\xbb\xbb')
306
 
 
307
844
    def test_none(self):
308
845
        """Currently, None is a valid revision_id"""
309
846
        self.assertEqual(None, osutils.safe_revision_id(None))
310
847
 
311
848
 
312
 
class TestSafeFileId(TestCase):
 
849
class TestSafeFileId(tests.TestCase):
313
850
 
314
851
    def test_from_ascii_string(self):
315
 
        f = 'foobar'
316
 
        self.assertEqual('foobar', osutils.safe_file_id(f))
 
852
        self.assertEqual('foobar', osutils.safe_file_id('foobar'))
317
853
 
318
854
    def test_from_unicode_string_ascii_contents(self):
319
 
        self.assertEqual('bargam', osutils.safe_file_id(u'bargam'))
 
855
        self.assertEqual('bargam', osutils.safe_file_id(u'bargam', warn=False))
 
856
 
 
857
    def test_from_unicode_deprecated(self):
 
858
        self.assertEqual('bargam',
 
859
            self.callDeprecated([osutils._file_id_warning],
 
860
                                osutils.safe_file_id, u'bargam'))
320
861
 
321
862
    def test_from_unicode_string_unicode_contents(self):
322
863
        self.assertEqual('bargam\xc2\xae',
323
 
                         osutils.safe_file_id(u'bargam\xae'))
 
864
                         osutils.safe_file_id(u'bargam\xae', warn=False))
324
865
 
325
866
    def test_from_utf8_string(self):
326
867
        self.assertEqual('foo\xc2\xae',
327
868
                         osutils.safe_file_id('foo\xc2\xae'))
328
869
 
329
 
    def test_bad_utf8_string(self):
330
 
        # This check may eventually go away
331
 
        self.assertRaises(BzrBadParameterNotUnicode,
332
 
                          osutils.safe_file_id, '\xbb\xbb')
333
 
 
334
870
    def test_none(self):
335
871
        """Currently, None is a valid revision_id"""
336
872
        self.assertEqual(None, osutils.safe_file_id(None))
337
873
 
338
874
 
339
 
class TestWin32Funcs(TestCase):
340
 
    """Test that the _win32 versions of os utilities return appropriate paths."""
 
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
 
 
924
class TestWin32Funcs(tests.TestCase):
 
925
    """Test that _win32 versions of os utilities return appropriate paths."""
341
926
 
342
927
    def test_abspath(self):
 
928
        self.requireFeature(features.win32_feature)
343
929
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
344
930
        self.assertEqual('C:/foo', osutils._win32_abspath('C:/foo'))
345
931
        self.assertEqual('//HOST/path', osutils._win32_abspath(r'\\HOST\path'))
350
936
        self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
351
937
 
352
938
    def test_pathjoin(self):
353
 
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path', 'to', 'foo'))
354
 
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path\\to', 'C:\\foo'))
355
 
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path/to', 'C:/foo'))
356
 
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path/to/', 'foo'))
357
 
        self.assertEqual('/foo', osutils._win32_pathjoin('C:/path/to/', '/foo'))
358
 
        self.assertEqual('/foo', osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
 
939
        self.assertEqual('path/to/foo',
 
940
                         osutils._win32_pathjoin('path', 'to', 'foo'))
 
941
        self.assertEqual('C:/foo',
 
942
                         osutils._win32_pathjoin('path\\to', 'C:\\foo'))
 
943
        self.assertEqual('C:/foo',
 
944
                         osutils._win32_pathjoin('path/to', 'C:/foo'))
 
945
        self.assertEqual('path/to/foo',
 
946
                         osutils._win32_pathjoin('path/to/', '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,
 
954
                         osutils._win32_pathjoin('C:/path/to/', '/foo'))
 
955
        self.assertEqual(expected,
 
956
                         osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
359
957
 
360
958
    def test_normpath(self):
361
 
        self.assertEqual('path/to/foo', osutils._win32_normpath(r'path\\from\..\to\.\foo'))
362
 
        self.assertEqual('path/to/foo', osutils._win32_normpath('path//from/../to/./foo'))
 
959
        self.assertEqual('path/to/foo',
 
960
                         osutils._win32_normpath(r'path\\from\..\to\.\foo'))
 
961
        self.assertEqual('path/to/foo',
 
962
                         osutils._win32_normpath('path//from/../to/./foo'))
363
963
 
364
964
    def test_getcwd(self):
365
965
        cwd = osutils._win32_getcwd()
378
978
        self.assertEqual('C:\\foo', osutils._win32_fixdrive('c:\\foo'))
379
979
 
380
980
    def test_win98_abspath(self):
 
981
        self.requireFeature(features.win32_feature)
381
982
        # absolute path
382
983
        self.assertEqual('C:/foo', osutils._win98_abspath('C:\\foo'))
383
984
        self.assertEqual('C:/foo', osutils._win98_abspath('C:/foo'))
386
987
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
387
988
        # relative path
388
989
        cwd = osutils.getcwd().rstrip('/')
389
 
        drive = osutils._nt_splitdrive(cwd)[0]
 
990
        drive = osutils.ntpath.splitdrive(cwd)[0]
390
991
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
391
992
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
392
993
        # unicode path
394
995
        self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
395
996
 
396
997
 
397
 
class TestWin32FuncsDirs(TestCaseInTempDir):
 
998
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
398
999
    """Test win32 functions that create files."""
399
 
    
 
1000
 
400
1001
    def test_getcwd(self):
401
 
        if win32utils.winver == 'Windows 98':
402
 
            raise TestSkipped('Windows 98 cannot handle unicode filenames')
403
 
        # Make sure getcwd can handle unicode filenames
404
 
        try:
405
 
            os.mkdir(u'mu-\xb5')
406
 
        except UnicodeError:
407
 
            raise TestSkipped("Unable to create Unicode filename")
408
 
 
 
1002
        self.requireFeature(features.UnicodeFilenameFeature)
 
1003
        os.mkdir(u'mu-\xb5')
409
1004
        os.chdir(u'mu-\xb5')
410
1005
        # TODO: jam 20060427 This will probably fail on Mac OSX because
411
1006
        #       it will change the normalization of B\xe5gfors
413
1008
        #       osutils.getcwd() renormalize the path.
414
1009
        self.assertEndsWith(osutils._win32_getcwd(), u'mu-\xb5')
415
1010
 
 
1011
    def test_minimum_path_selection(self):
 
1012
        self.assertEqual(set(),
 
1013
            osutils.minimum_path_selection([]))
 
1014
        self.assertEqual(set(['a']),
 
1015
            osutils.minimum_path_selection(['a']))
 
1016
        self.assertEqual(set(['a', 'b']),
 
1017
            osutils.minimum_path_selection(['a', 'b']))
 
1018
        self.assertEqual(set(['a/', 'b']),
 
1019
            osutils.minimum_path_selection(['a/', 'b']))
 
1020
        self.assertEqual(set(['a/', 'b']),
 
1021
            osutils.minimum_path_selection(['a/c', 'a/', 'b']))
 
1022
        self.assertEqual(set(['a-b', 'a', 'a0b']),
 
1023
            osutils.minimum_path_selection(['a-b', 'a/b', 'a0b', 'a']))
 
1024
 
416
1025
    def test_mkdtemp(self):
417
1026
        tmpdir = osutils._win32_mkdtemp(dir='.')
418
1027
        self.assertFalse('\\' in tmpdir)
426
1035
        b.close()
427
1036
 
428
1037
        osutils._win32_rename('b', 'a')
429
 
        self.failUnlessExists('a')
430
 
        self.failIfExists('b')
 
1038
        self.assertPathExists('a')
 
1039
        self.assertPathDoesNotExist('b')
431
1040
        self.assertFileEqual('baz\n', 'a')
432
1041
 
433
1042
    def test_rename_missing_file(self):
473
1082
        self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
474
1083
 
475
1084
 
476
 
class TestMacFuncsDirs(TestCaseInTempDir):
 
1085
class TestParentDirectories(tests.TestCaseInTempDir):
 
1086
    """Test osutils.parent_directories()"""
 
1087
 
 
1088
    def test_parent_directories(self):
 
1089
        self.assertEqual([], osutils.parent_directories('a'))
 
1090
        self.assertEqual(['a'], osutils.parent_directories('a/b'))
 
1091
        self.assertEqual(['a/b', 'a'], osutils.parent_directories('a/b/c'))
 
1092
 
 
1093
 
 
1094
class TestMacFuncsDirs(tests.TestCaseInTempDir):
477
1095
    """Test mac special functions that require directories."""
478
1096
 
479
1097
    def test_getcwd(self):
480
 
        # On Mac, this will actually create Ba\u030agfors
481
 
        # but chdir will still work, because it accepts both paths
482
 
        try:
483
 
            os.mkdir(u'B\xe5gfors')
484
 
        except UnicodeError:
485
 
            raise TestSkipped("Unable to create Unicode filename")
486
 
 
 
1098
        self.requireFeature(features.UnicodeFilenameFeature)
 
1099
        os.mkdir(u'B\xe5gfors')
487
1100
        os.chdir(u'B\xe5gfors')
488
1101
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
489
1102
 
490
1103
    def test_getcwd_nonnorm(self):
 
1104
        self.requireFeature(features.UnicodeFilenameFeature)
491
1105
        # Test that _mac_getcwd() will normalize this path
492
 
        try:
493
 
            os.mkdir(u'Ba\u030agfors')
494
 
        except UnicodeError:
495
 
            raise TestSkipped("Unable to create Unicode filename")
496
 
 
 
1106
        os.mkdir(u'Ba\u030agfors')
497
1107
        os.chdir(u'Ba\u030agfors')
498
1108
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
499
1109
 
500
1110
 
501
 
class TestSplitLines(TestCase):
 
1111
class TestChunksToLines(tests.TestCase):
 
1112
 
 
1113
    def test_smoketest(self):
 
1114
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
 
1115
                         osutils.chunks_to_lines(['foo\nbar', '\nbaz\n']))
 
1116
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
 
1117
                         osutils.chunks_to_lines(['foo\n', 'bar\n', 'baz\n']))
 
1118
 
 
1119
    def test_osutils_binding(self):
 
1120
        from bzrlib.tests import test__chunks_to_lines
 
1121
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
 
1122
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1123
        else:
 
1124
            from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1125
        self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
 
1126
 
 
1127
 
 
1128
class TestSplitLines(tests.TestCase):
502
1129
 
503
1130
    def test_split_unicode(self):
504
1131
        self.assertEqual([u'foo\n', u'bar\xae'],
511
1138
                         osutils.split_lines('foo\rbar\n'))
512
1139
 
513
1140
 
514
 
class TestWalkDirs(TestCaseInTempDir):
 
1141
class TestWalkDirs(tests.TestCaseInTempDir):
 
1142
 
 
1143
    def assertExpectedBlocks(self, expected, result):
 
1144
        self.assertEqual(expected,
 
1145
                         [(dirinfo, [line[0:3] for line in block])
 
1146
                          for dirinfo, block in result])
515
1147
 
516
1148
    def test_walkdirs(self):
517
1149
        tree = [
550
1182
            result.append((dirdetail, dirblock))
551
1183
 
552
1184
        self.assertTrue(found_bzrdir)
553
 
        self.assertEqual(expected_dirblocks,
554
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1185
        self.assertExpectedBlocks(expected_dirblocks, result)
555
1186
        # you can search a subdir only, with a supplied prefix.
556
1187
        result = []
557
1188
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
558
1189
            result.append(dirblock)
559
 
        self.assertEqual(expected_dirblocks[1:],
560
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1190
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
 
1191
 
 
1192
    def test_walkdirs_os_error(self):
 
1193
        # <https://bugs.launchpad.net/bzr/+bug/338653>
 
1194
        # Pyrex readdir didn't raise useful messages if it had an error
 
1195
        # reading the directory
 
1196
        if sys.platform == 'win32':
 
1197
            raise tests.TestNotApplicable(
 
1198
                "readdir IOError not tested on win32")
 
1199
        self.requireFeature(features.not_running_as_root)
 
1200
        os.mkdir("test-unreadable")
 
1201
        os.chmod("test-unreadable", 0000)
 
1202
        # must chmod it back so that it can be removed
 
1203
        self.addCleanup(os.chmod, "test-unreadable", 0700)
 
1204
        # The error is not raised until the generator is actually evaluated.
 
1205
        # (It would be ok if it happened earlier but at the moment it
 
1206
        # doesn't.)
 
1207
        e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
 
1208
        self.assertEquals('./test-unreadable', e.filename)
 
1209
        self.assertEquals(errno.EACCES, e.errno)
 
1210
        # Ensure the message contains the file name
 
1211
        self.assertContainsRe(str(e), "\./test-unreadable")
 
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)
561
1248
 
562
1249
    def test__walkdirs_utf8(self):
563
1250
        tree = [
596
1283
            result.append((dirdetail, dirblock))
597
1284
 
598
1285
        self.assertTrue(found_bzrdir)
599
 
        self.assertEqual(expected_dirblocks,
600
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1286
        self.assertExpectedBlocks(expected_dirblocks, result)
 
1287
 
601
1288
        # you can search a subdir only, with a supplied prefix.
602
1289
        result = []
603
1290
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
604
1291
            result.append(dirblock)
605
 
        self.assertEqual(expected_dirblocks[1:],
606
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1292
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
607
1293
 
608
1294
    def _filter_out_stat(self, result):
609
1295
        """Filter out the stat value from the walkdirs result"""
614
1300
                new_dirblock.append((info[0], info[1], info[2], info[4]))
615
1301
            dirblock[:] = new_dirblock
616
1302
 
 
1303
    def _save_platform_info(self):
 
1304
        self.overrideAttr(win32utils, 'winver')
 
1305
        self.overrideAttr(osutils, '_fs_enc')
 
1306
        self.overrideAttr(osutils, '_selected_dir_reader')
 
1307
 
 
1308
    def assertDirReaderIs(self, expected):
 
1309
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
 
1310
        # Force it to redetect
 
1311
        osutils._selected_dir_reader = None
 
1312
        # Nothing to list, but should still trigger the selection logic
 
1313
        self.assertEqual([(('', '.'), [])], list(osutils._walkdirs_utf8('.')))
 
1314
        self.assertIsInstance(osutils._selected_dir_reader, expected)
 
1315
 
 
1316
    def test_force_walkdirs_utf8_fs_utf8(self):
 
1317
        self.requireFeature(UTF8DirReaderFeature)
 
1318
        self._save_platform_info()
 
1319
        win32utils.winver = None # Avoid the win32 detection code
 
1320
        osutils._fs_enc = 'utf-8'
 
1321
        self.assertDirReaderIs(
 
1322
            UTF8DirReaderFeature.module.UTF8DirReader)
 
1323
 
 
1324
    def test_force_walkdirs_utf8_fs_ascii(self):
 
1325
        self.requireFeature(UTF8DirReaderFeature)
 
1326
        self._save_platform_info()
 
1327
        win32utils.winver = None # Avoid the win32 detection code
 
1328
        osutils._fs_enc = 'ascii'
 
1329
        self.assertDirReaderIs(
 
1330
            UTF8DirReaderFeature.module.UTF8DirReader)
 
1331
 
 
1332
    def test_force_walkdirs_utf8_fs_latin1(self):
 
1333
        self._save_platform_info()
 
1334
        win32utils.winver = None # Avoid the win32 detection code
 
1335
        osutils._fs_enc = 'iso-8859-1'
 
1336
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
1337
 
 
1338
    def test_force_walkdirs_utf8_nt(self):
 
1339
        # Disabled because the thunk of the whole walkdirs api is disabled.
 
1340
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1341
        self._save_platform_info()
 
1342
        win32utils.winver = 'Windows NT'
 
1343
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1344
        self.assertDirReaderIs(Win32ReadDir)
 
1345
 
 
1346
    def test_force_walkdirs_utf8_98(self):
 
1347
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1348
        self._save_platform_info()
 
1349
        win32utils.winver = 'Windows 98'
 
1350
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
1351
 
617
1352
    def test_unicode_walkdirs(self):
618
1353
        """Walkdirs should always return unicode paths."""
 
1354
        self.requireFeature(features.UnicodeFilenameFeature)
619
1355
        name0 = u'0file-\xb6'
620
1356
        name1 = u'1dir-\u062c\u0648'
621
1357
        name2 = u'2file-\u0633'
626
1362
            name1 + '/' + name1 + '/',
627
1363
            name2,
628
1364
            ]
629
 
        try:
630
 
            self.build_tree(tree)
631
 
        except UnicodeError:
632
 
            raise TestSkipped('Could not represent Unicode chars'
633
 
                              ' in current encoding.')
 
1365
        self.build_tree(tree)
634
1366
        expected_dirblocks = [
635
1367
                ((u'', u'.'),
636
1368
                 [(name0, name0, 'file', './' + name0),
662
1394
 
663
1395
        The abspath portion might be in unicode or utf-8
664
1396
        """
 
1397
        self.requireFeature(features.UnicodeFilenameFeature)
665
1398
        name0 = u'0file-\xb6'
666
1399
        name1 = u'1dir-\u062c\u0648'
667
1400
        name2 = u'2file-\u0633'
672
1405
            name1 + '/' + name1 + '/',
673
1406
            name2,
674
1407
            ]
675
 
        try:
676
 
            self.build_tree(tree)
677
 
        except UnicodeError:
678
 
            raise TestSkipped('Could not represent Unicode chars'
679
 
                              ' in current encoding.')
 
1408
        self.build_tree(tree)
680
1409
        name0 = name0.encode('utf8')
681
1410
        name1 = name1.encode('utf8')
682
1411
        name2 = name2.encode('utf8')
706
1435
        for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
707
1436
            self.assertIsInstance(dirdetail[0], str)
708
1437
            if isinstance(dirdetail[1], unicode):
709
 
                dirdetail[1] = dirdetail[1].encode('utf8')
 
1438
                dirdetail = (dirdetail[0], dirdetail[1].encode('utf8'))
 
1439
                dirblock = [list(info) for info in dirblock]
710
1440
                for info in dirblock:
711
1441
                    self.assertIsInstance(info[4], unicode)
712
1442
                    info[4] = info[4].encode('utf8')
720
1450
            result.append((dirdetail, new_dirblock))
721
1451
        self.assertEqual(expected_dirblocks, result)
722
1452
 
723
 
    def test_unicode__walkdirs_unicode_to_utf8(self):
724
 
        """walkdirs_unicode_to_utf8 should be a safe fallback everywhere
 
1453
    def test__walkdirs_utf8_with_unicode_fs(self):
 
1454
        """UnicodeDirReader should be a safe fallback everywhere
725
1455
 
726
1456
        The abspath portion should be in unicode
727
1457
        """
728
 
        name0u = u'0file-\xb6'
729
 
        name1u = u'1dir-\u062c\u0648'
730
 
        name2u = u'2file-\u0633'
731
 
        tree = [
732
 
            name0u,
733
 
            name1u + '/',
734
 
            name1u + '/' + name0u,
735
 
            name1u + '/' + name1u + '/',
736
 
            name2u,
737
 
            ]
 
1458
        self.requireFeature(features.UnicodeFilenameFeature)
 
1459
        # Use the unicode reader. TODO: split into driver-and-driven unit
 
1460
        # tests.
 
1461
        self._save_platform_info()
 
1462
        osutils._selected_dir_reader = osutils.UnicodeDirReader()
 
1463
        name0u = u'0file-\xb6'
 
1464
        name1u = u'1dir-\u062c\u0648'
 
1465
        name2u = u'2file-\u0633'
 
1466
        tree = [
 
1467
            name0u,
 
1468
            name1u + '/',
 
1469
            name1u + '/' + name0u,
 
1470
            name1u + '/' + name1u + '/',
 
1471
            name2u,
 
1472
            ]
 
1473
        self.build_tree(tree)
 
1474
        name0 = name0u.encode('utf8')
 
1475
        name1 = name1u.encode('utf8')
 
1476
        name2 = name2u.encode('utf8')
 
1477
 
 
1478
        # All of the abspaths should be in unicode, all of the relative paths
 
1479
        # should be in utf8
 
1480
        expected_dirblocks = [
 
1481
                (('', '.'),
 
1482
                 [(name0, name0, 'file', './' + name0u),
 
1483
                  (name1, name1, 'directory', './' + name1u),
 
1484
                  (name2, name2, 'file', './' + name2u),
 
1485
                 ]
 
1486
                ),
 
1487
                ((name1, './' + name1u),
 
1488
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1489
                                                        + '/' + name0u),
 
1490
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1491
                                                            + '/' + name1u),
 
1492
                 ]
 
1493
                ),
 
1494
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1495
                 [
 
1496
                 ]
 
1497
                ),
 
1498
            ]
 
1499
        result = list(osutils._walkdirs_utf8('.'))
 
1500
        self._filter_out_stat(result)
 
1501
        self.assertEqual(expected_dirblocks, result)
 
1502
 
 
1503
    def test__walkdirs_utf8_win32readdir(self):
 
1504
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1505
        self.requireFeature(features.UnicodeFilenameFeature)
 
1506
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1507
        self._save_platform_info()
 
1508
        osutils._selected_dir_reader = Win32ReadDir()
 
1509
        name0u = u'0file-\xb6'
 
1510
        name1u = u'1dir-\u062c\u0648'
 
1511
        name2u = u'2file-\u0633'
 
1512
        tree = [
 
1513
            name0u,
 
1514
            name1u + '/',
 
1515
            name1u + '/' + name0u,
 
1516
            name1u + '/' + name1u + '/',
 
1517
            name2u,
 
1518
            ]
 
1519
        self.build_tree(tree)
 
1520
        name0 = name0u.encode('utf8')
 
1521
        name1 = name1u.encode('utf8')
 
1522
        name2 = name2u.encode('utf8')
 
1523
 
 
1524
        # All of the abspaths should be in unicode, all of the relative paths
 
1525
        # should be in utf8
 
1526
        expected_dirblocks = [
 
1527
                (('', '.'),
 
1528
                 [(name0, name0, 'file', './' + name0u),
 
1529
                  (name1, name1, 'directory', './' + name1u),
 
1530
                  (name2, name2, 'file', './' + name2u),
 
1531
                 ]
 
1532
                ),
 
1533
                ((name1, './' + name1u),
 
1534
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1535
                                                        + '/' + name0u),
 
1536
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1537
                                                            + '/' + name1u),
 
1538
                 ]
 
1539
                ),
 
1540
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1541
                 [
 
1542
                 ]
 
1543
                ),
 
1544
            ]
 
1545
        result = list(osutils._walkdirs_utf8(u'.'))
 
1546
        self._filter_out_stat(result)
 
1547
        self.assertEqual(expected_dirblocks, result)
 
1548
 
 
1549
    def assertStatIsCorrect(self, path, win32stat):
 
1550
        os_stat = os.stat(path)
 
1551
        self.assertEqual(os_stat.st_size, win32stat.st_size)
 
1552
        self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
 
1553
        self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
 
1554
        self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
 
1555
        self.assertEqual(os_stat.st_dev, win32stat.st_dev)
 
1556
        self.assertEqual(os_stat.st_ino, win32stat.st_ino)
 
1557
        self.assertEqual(os_stat.st_mode, win32stat.st_mode)
 
1558
 
 
1559
    def test__walkdirs_utf_win32_find_file_stat_file(self):
 
1560
        """make sure our Stat values are valid"""
 
1561
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1562
        self.requireFeature(features.UnicodeFilenameFeature)
 
1563
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1564
        name0u = u'0file-\xb6'
 
1565
        name0 = name0u.encode('utf8')
 
1566
        self.build_tree([name0u])
 
1567
        # I hate to sleep() here, but I'm trying to make the ctime different
 
1568
        # from the mtime
 
1569
        time.sleep(2)
 
1570
        f = open(name0u, 'ab')
738
1571
        try:
739
 
            self.build_tree(tree)
740
 
        except UnicodeError:
741
 
            raise TestSkipped('Could not represent Unicode chars'
742
 
                              ' in current encoding.')
 
1572
            f.write('just a small update')
 
1573
        finally:
 
1574
            f.close()
 
1575
 
 
1576
        result = Win32ReadDir().read_dir('', u'.')
 
1577
        entry = result[0]
 
1578
        self.assertEqual((name0, name0, 'file'), entry[:3])
 
1579
        self.assertEqual(u'./' + name0u, entry[4])
 
1580
        self.assertStatIsCorrect(entry[4], entry[3])
 
1581
        self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
 
1582
 
 
1583
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
 
1584
        """make sure our Stat values are valid"""
 
1585
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1586
        self.requireFeature(features.UnicodeFilenameFeature)
 
1587
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1588
        name0u = u'0dir-\u062c\u0648'
743
1589
        name0 = name0u.encode('utf8')
744
 
        name1 = name1u.encode('utf8')
745
 
        name2 = name2u.encode('utf8')
 
1590
        self.build_tree([name0u + '/'])
746
1591
 
747
 
        # All of the abspaths should be in unicode, all of the relative paths
748
 
        # should be in utf8
749
 
        expected_dirblocks = [
750
 
                (('', '.'),
751
 
                 [(name0, name0, 'file', './' + name0u),
752
 
                  (name1, name1, 'directory', './' + name1u),
753
 
                  (name2, name2, 'file', './' + name2u),
754
 
                 ]
755
 
                ),
756
 
                ((name1, './' + name1u),
757
 
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
758
 
                                                        + '/' + name0u),
759
 
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
760
 
                                                            + '/' + name1u),
761
 
                 ]
762
 
                ),
763
 
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
764
 
                 [
765
 
                 ]
766
 
                ),
767
 
            ]
768
 
        result = list(osutils._walkdirs_unicode_to_utf8('.'))
769
 
        self._filter_out_stat(result)
770
 
        self.assertEqual(expected_dirblocks, result)
 
1592
        result = Win32ReadDir().read_dir('', u'.')
 
1593
        entry = result[0]
 
1594
        self.assertEqual((name0, name0, 'directory'), entry[:3])
 
1595
        self.assertEqual(u'./' + name0u, entry[4])
 
1596
        self.assertStatIsCorrect(entry[4], entry[3])
771
1597
 
772
1598
    def assertPathCompare(self, path_less, path_greater):
773
1599
        """check that path_less and path_greater compare correctly."""
847
1673
            sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
848
1674
 
849
1675
 
850
 
class TestCopyTree(TestCaseInTempDir):
851
 
    
 
1676
class TestCopyTree(tests.TestCaseInTempDir):
 
1677
 
852
1678
    def test_copy_basic_tree(self):
853
1679
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
854
1680
        osutils.copy_tree('source', 'target')
863
1689
        self.assertEqual(['c'], os.listdir('target/b'))
864
1690
 
865
1691
    def test_copy_tree_symlinks(self):
866
 
        if not osutils.has_symlinks():
867
 
            return
 
1692
        self.requireFeature(features.SymlinkFeature)
868
1693
        self.build_tree(['source/'])
869
1694
        os.symlink('a/generic/path', 'source/lnk')
870
1695
        osutils.copy_tree('source', 'target')
895
1720
                          ('d', 'source/b', 'target/b'),
896
1721
                          ('f', 'source/b/c', 'target/b/c'),
897
1722
                         ], processed_files)
898
 
        self.failIfExists('target')
 
1723
        self.assertPathDoesNotExist('target')
899
1724
        if osutils.has_symlinks():
900
1725
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
901
1726
 
902
1727
 
903
 
#class TestTerminalEncoding has been moved to test_osutils_encodings.py
904
 
# [bialix] 2006/12/26
905
 
 
906
 
 
907
 
class TestSetUnsetEnv(TestCase):
 
1728
class TestSetUnsetEnv(tests.TestCase):
908
1729
    """Test updating the environment"""
909
1730
 
910
1731
    def setUp(self):
916
1737
        def cleanup():
917
1738
            if 'BZR_TEST_ENV_VAR' in os.environ:
918
1739
                del os.environ['BZR_TEST_ENV_VAR']
919
 
 
920
1740
        self.addCleanup(cleanup)
921
1741
 
922
1742
    def test_set(self):
934
1754
 
935
1755
    def test_unicode(self):
936
1756
        """Environment can only contain plain strings
937
 
        
 
1757
 
938
1758
        So Unicode strings must be encoded.
939
1759
        """
940
 
        # Try a few different characters, to see if we can get
941
 
        # one that will be valid in the user_encoding
942
 
        possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
943
 
        for uni_val in possible_vals:
944
 
            try:
945
 
                env_val = uni_val.encode(bzrlib.user_encoding)
946
 
            except UnicodeEncodeError:
947
 
                # Try a different character
948
 
                pass
949
 
            else:
950
 
                break
951
 
        else:
952
 
            raise TestSkipped('Cannot find a unicode character that works in'
953
 
                              ' encoding %s' % (bzrlib.user_encoding,))
 
1760
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
1761
        if uni_val is None:
 
1762
            raise tests.TestSkipped(
 
1763
                'Cannot find a unicode character that works in encoding %s'
 
1764
                % (osutils.get_user_encoding(),))
954
1765
 
955
1766
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
956
1767
        self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
961
1772
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
962
1773
        self.assertEqual('foo', old)
963
1774
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
964
 
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
965
 
 
966
 
 
967
 
class TestLocalTimeOffset(TestCase):
968
 
 
969
 
    def test_local_time_offset(self):
970
 
        """Test that local_time_offset() returns a sane value."""
971
 
        offset = osutils.local_time_offset()
972
 
        self.assertTrue(isinstance(offset, int))
973
 
        # Test that the offset is no more than a eighteen hours in
974
 
        # either direction.
975
 
        # Time zone handling is system specific, so it is difficult to
976
 
        # do more specific tests, but a value outside of this range is
977
 
        # probably wrong.
978
 
        eighteen_hours = 18 * 3600
979
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
980
 
 
981
 
    def test_local_time_offset_with_timestamp(self):
982
 
        """Test that local_time_offset() works with a timestamp."""
983
 
        offset = osutils.local_time_offset(1000000000.1234567)
984
 
        self.assertTrue(isinstance(offset, int))
985
 
        eighteen_hours = 18 * 3600
986
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
1775
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
 
1776
 
 
1777
 
 
1778
class TestSizeShaFile(tests.TestCaseInTempDir):
 
1779
 
 
1780
    def test_sha_empty(self):
 
1781
        self.build_tree_contents([('foo', '')])
 
1782
        expected_sha = osutils.sha_string('')
 
1783
        f = open('foo')
 
1784
        self.addCleanup(f.close)
 
1785
        size, sha = osutils.size_sha_file(f)
 
1786
        self.assertEqual(0, size)
 
1787
        self.assertEqual(expected_sha, sha)
 
1788
 
 
1789
    def test_sha_mixed_endings(self):
 
1790
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1791
        self.build_tree_contents([('foo', text)])
 
1792
        expected_sha = osutils.sha_string(text)
 
1793
        f = open('foo', 'rb')
 
1794
        self.addCleanup(f.close)
 
1795
        size, sha = osutils.size_sha_file(f)
 
1796
        self.assertEqual(38, size)
 
1797
        self.assertEqual(expected_sha, sha)
 
1798
 
 
1799
 
 
1800
class TestShaFileByName(tests.TestCaseInTempDir):
 
1801
 
 
1802
    def test_sha_empty(self):
 
1803
        self.build_tree_contents([('foo', '')])
 
1804
        expected_sha = osutils.sha_string('')
 
1805
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1806
 
 
1807
    def test_sha_mixed_endings(self):
 
1808
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1809
        self.build_tree_contents([('foo', text)])
 
1810
        expected_sha = osutils.sha_string(text)
 
1811
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1812
 
 
1813
 
 
1814
class TestResourceLoading(tests.TestCaseInTempDir):
 
1815
 
 
1816
    def test_resource_string(self):
 
1817
        # test resource in bzrlib
 
1818
        text = osutils.resource_string('bzrlib', 'debug.py')
 
1819
        self.assertContainsRe(text, "debug_flags = set()")
 
1820
        # test resource under bzrlib
 
1821
        text = osutils.resource_string('bzrlib.ui', 'text.py')
 
1822
        self.assertContainsRe(text, "class TextUIFactory")
 
1823
        # test unsupported package
 
1824
        self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
 
1825
            'yyy.xx')
 
1826
        # test unknown resource
 
1827
        self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
 
1828
 
 
1829
 
 
1830
class TestReCompile(tests.TestCase):
 
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
 
 
1836
    def test_re_compile_checked(self):
 
1837
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
 
1838
        self.assertTrue(r.match('aaaa'))
 
1839
        self.assertTrue(r.match('aAaA'))
 
1840
 
 
1841
    def test_re_compile_checked_error(self):
 
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()
 
1847
        err = self.assertRaises(
 
1848
            errors.BzrCommandError,
 
1849
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1850
        self.assertEqual(
 
1851
            'Invalid regular expression in test case: '
 
1852
            '"*" nothing to repeat',
 
1853
            str(err))
 
1854
 
 
1855
 
 
1856
class TestDirReader(tests.TestCaseInTempDir):
 
1857
 
 
1858
    scenarios = dir_reader_scenarios()
 
1859
 
 
1860
    # Set by load_tests
 
1861
    _dir_reader_class = None
 
1862
    _native_to_unicode = None
 
1863
 
 
1864
    def setUp(self):
 
1865
        super(TestDirReader, self).setUp()
 
1866
        self.overrideAttr(osutils,
 
1867
                          '_selected_dir_reader', self._dir_reader_class())
 
1868
 
 
1869
    def _get_ascii_tree(self):
 
1870
        tree = [
 
1871
            '0file',
 
1872
            '1dir/',
 
1873
            '1dir/0file',
 
1874
            '1dir/1dir/',
 
1875
            '2file'
 
1876
            ]
 
1877
        expected_dirblocks = [
 
1878
                (('', '.'),
 
1879
                 [('0file', '0file', 'file'),
 
1880
                  ('1dir', '1dir', 'directory'),
 
1881
                  ('2file', '2file', 'file'),
 
1882
                 ]
 
1883
                ),
 
1884
                (('1dir', './1dir'),
 
1885
                 [('1dir/0file', '0file', 'file'),
 
1886
                  ('1dir/1dir', '1dir', 'directory'),
 
1887
                 ]
 
1888
                ),
 
1889
                (('1dir/1dir', './1dir/1dir'),
 
1890
                 [
 
1891
                 ]
 
1892
                ),
 
1893
            ]
 
1894
        return tree, expected_dirblocks
 
1895
 
 
1896
    def test_walk_cur_dir(self):
 
1897
        tree, expected_dirblocks = self._get_ascii_tree()
 
1898
        self.build_tree(tree)
 
1899
        result = list(osutils._walkdirs_utf8('.'))
 
1900
        # Filter out stat and abspath
 
1901
        self.assertEqual(expected_dirblocks,
 
1902
                         [(dirinfo, [line[0:3] for line in block])
 
1903
                          for dirinfo, block in result])
 
1904
 
 
1905
    def test_walk_sub_dir(self):
 
1906
        tree, expected_dirblocks = self._get_ascii_tree()
 
1907
        self.build_tree(tree)
 
1908
        # you can search a subdir only, with a supplied prefix.
 
1909
        result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
 
1910
        # Filter out stat and abspath
 
1911
        self.assertEqual(expected_dirblocks[1:],
 
1912
                         [(dirinfo, [line[0:3] for line in block])
 
1913
                          for dirinfo, block in result])
 
1914
 
 
1915
    def _get_unicode_tree(self):
 
1916
        name0u = u'0file-\xb6'
 
1917
        name1u = u'1dir-\u062c\u0648'
 
1918
        name2u = u'2file-\u0633'
 
1919
        tree = [
 
1920
            name0u,
 
1921
            name1u + '/',
 
1922
            name1u + '/' + name0u,
 
1923
            name1u + '/' + name1u + '/',
 
1924
            name2u,
 
1925
            ]
 
1926
        name0 = name0u.encode('UTF-8')
 
1927
        name1 = name1u.encode('UTF-8')
 
1928
        name2 = name2u.encode('UTF-8')
 
1929
        expected_dirblocks = [
 
1930
                (('', '.'),
 
1931
                 [(name0, name0, 'file', './' + name0u),
 
1932
                  (name1, name1, 'directory', './' + name1u),
 
1933
                  (name2, name2, 'file', './' + name2u),
 
1934
                 ]
 
1935
                ),
 
1936
                ((name1, './' + name1u),
 
1937
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1938
                                                        + '/' + name0u),
 
1939
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1940
                                                            + '/' + name1u),
 
1941
                 ]
 
1942
                ),
 
1943
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1944
                 [
 
1945
                 ]
 
1946
                ),
 
1947
            ]
 
1948
        return tree, expected_dirblocks
 
1949
 
 
1950
    def _filter_out(self, raw_dirblocks):
 
1951
        """Filter out a walkdirs_utf8 result.
 
1952
 
 
1953
        stat field is removed, all native paths are converted to unicode
 
1954
        """
 
1955
        filtered_dirblocks = []
 
1956
        for dirinfo, block in raw_dirblocks:
 
1957
            dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
 
1958
            details = []
 
1959
            for line in block:
 
1960
                details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
 
1961
            filtered_dirblocks.append((dirinfo, details))
 
1962
        return filtered_dirblocks
 
1963
 
 
1964
    def test_walk_unicode_tree(self):
 
1965
        self.requireFeature(features.UnicodeFilenameFeature)
 
1966
        tree, expected_dirblocks = self._get_unicode_tree()
 
1967
        self.build_tree(tree)
 
1968
        result = list(osutils._walkdirs_utf8('.'))
 
1969
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1970
 
 
1971
    def test_symlink(self):
 
1972
        self.requireFeature(features.SymlinkFeature)
 
1973
        self.requireFeature(features.UnicodeFilenameFeature)
 
1974
        target = u'target\N{Euro Sign}'
 
1975
        link_name = u'l\N{Euro Sign}nk'
 
1976
        os.symlink(target, link_name)
 
1977
        target_utf8 = target.encode('UTF-8')
 
1978
        link_name_utf8 = link_name.encode('UTF-8')
 
1979
        expected_dirblocks = [
 
1980
                (('', '.'),
 
1981
                 [(link_name_utf8, link_name_utf8,
 
1982
                   'symlink', './' + link_name),],
 
1983
                 )]
 
1984
        result = list(osutils._walkdirs_utf8('.'))
 
1985
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1986
 
 
1987
 
 
1988
class TestReadLink(tests.TestCaseInTempDir):
 
1989
    """Exposes os.readlink() problems and the osutils solution.
 
1990
 
 
1991
    The only guarantee offered by os.readlink(), starting with 2.6, is that a
 
1992
    unicode string will be returned if a unicode string is passed.
 
1993
 
 
1994
    But prior python versions failed to properly encode the passed unicode
 
1995
    string.
 
1996
    """
 
1997
    _test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
 
1998
 
 
1999
    def setUp(self):
 
2000
        super(tests.TestCaseInTempDir, self).setUp()
 
2001
        self.link = u'l\N{Euro Sign}ink'
 
2002
        self.target = u'targe\N{Euro Sign}t'
 
2003
        os.symlink(self.target, self.link)
 
2004
 
 
2005
    def test_os_readlink_link_encoding(self):
 
2006
        self.assertEquals(self.target,  os.readlink(self.link))
 
2007
 
 
2008
    def test_os_readlink_link_decoding(self):
 
2009
        self.assertEquals(self.target.encode(osutils._fs_enc),
 
2010
                          os.readlink(self.link.encode(osutils._fs_enc)))
 
2011
 
 
2012
 
 
2013
class TestConcurrency(tests.TestCase):
 
2014
 
 
2015
    def setUp(self):
 
2016
        super(TestConcurrency, self).setUp()
 
2017
        self.overrideAttr(osutils, '_cached_local_concurrency')
 
2018
 
 
2019
    def test_local_concurrency(self):
 
2020
        concurrency = osutils.local_concurrency()
 
2021
        self.assertIsInstance(concurrency, int)
 
2022
 
 
2023
    def test_local_concurrency_environment_variable(self):
 
2024
        self.overrideEnv('BZR_CONCURRENCY', '2')
 
2025
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
 
2026
        self.overrideEnv('BZR_CONCURRENCY', '3')
 
2027
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
 
2028
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
 
2029
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
 
2030
 
 
2031
    def test_option_concurrency(self):
 
2032
        self.overrideEnv('BZR_CONCURRENCY', '1')
 
2033
        self.run_bzr('rocks --concurrency 42')
 
2034
        # Command line overrides environment variable
 
2035
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
 
2036
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
 
2037
 
 
2038
 
 
2039
class TestFailedToLoadExtension(tests.TestCase):
 
2040
 
 
2041
    def _try_loading(self):
 
2042
        try:
 
2043
            import bzrlib._fictional_extension_py
 
2044
        except ImportError, e:
 
2045
            osutils.failed_to_load_extension(e)
 
2046
            return True
 
2047
 
 
2048
    def setUp(self):
 
2049
        super(TestFailedToLoadExtension, self).setUp()
 
2050
        self.overrideAttr(osutils, '_extension_load_failures', [])
 
2051
 
 
2052
    def test_failure_to_load(self):
 
2053
        self._try_loading()
 
2054
        self.assertLength(1, osutils._extension_load_failures)
 
2055
        self.assertEquals(osutils._extension_load_failures[0],
 
2056
            "No module named _fictional_extension_py")
 
2057
 
 
2058
    def test_report_extension_load_failures_no_warning(self):
 
2059
        self.assertTrue(self._try_loading())
 
2060
        warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
 
2061
        # it used to give a Python warning; it no longer does
 
2062
        self.assertLength(0, warnings)
 
2063
 
 
2064
    def test_report_extension_load_failures_message(self):
 
2065
        log = StringIO()
 
2066
        trace.push_log_file(log)
 
2067
        self.assertTrue(self._try_loading())
 
2068
        osutils.report_extension_load_failures()
 
2069
        self.assertContainsRe(
 
2070
            log.getvalue(),
 
2071
            r"bzr: warning: some compiled extensions could not be loaded; "
 
2072
            "see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
 
2073
            )
 
2074
 
 
2075
 
 
2076
class TestTerminalWidth(tests.TestCase):
 
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
 
 
2090
    def replace_stdout(self, new):
 
2091
        self.overrideAttr(sys, 'stdout', new)
 
2092
 
 
2093
    def replace__terminal_size(self, new):
 
2094
        self.overrideAttr(osutils, '_terminal_size', new)
 
2095
 
 
2096
    def set_fake_tty(self):
 
2097
 
 
2098
        class I_am_a_tty(object):
 
2099
            def isatty(self):
 
2100
                return True
 
2101
 
 
2102
        self.replace_stdout(I_am_a_tty())
 
2103
 
 
2104
    def test_default_values(self):
 
2105
        self.assertEqual(80, osutils.default_terminal_width)
 
2106
 
 
2107
    def test_defaults_to_BZR_COLUMNS(self):
 
2108
        # BZR_COLUMNS is set by the test framework
 
2109
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
 
2110
        self.overrideEnv('BZR_COLUMNS', '12')
 
2111
        self.assertEqual(12, osutils.terminal_width())
 
2112
 
 
2113
    def test_BZR_COLUMNS_0_no_limit(self):
 
2114
        self.overrideEnv('BZR_COLUMNS', '0')
 
2115
        self.assertEqual(None, osutils.terminal_width())
 
2116
 
 
2117
    def test_falls_back_to_COLUMNS(self):
 
2118
        self.overrideEnv('BZR_COLUMNS', None)
 
2119
        self.assertNotEqual('42', os.environ['COLUMNS'])
 
2120
        self.set_fake_tty()
 
2121
        self.overrideEnv('COLUMNS', '42')
 
2122
        self.assertEqual(42, osutils.terminal_width())
 
2123
 
 
2124
    def test_tty_default_without_columns(self):
 
2125
        self.overrideEnv('BZR_COLUMNS', None)
 
2126
        self.overrideEnv('COLUMNS', None)
 
2127
 
 
2128
        def terminal_size(w, h):
 
2129
            return 42, 42
 
2130
 
 
2131
        self.set_fake_tty()
 
2132
        # We need to override the osutils definition as it depends on the
 
2133
        # running environment that we can't control (PQM running without a
 
2134
        # controlling terminal is one example).
 
2135
        self.replace__terminal_size(terminal_size)
 
2136
        self.assertEqual(42, osutils.terminal_width())
 
2137
 
 
2138
    def test_non_tty_default_without_columns(self):
 
2139
        self.overrideEnv('BZR_COLUMNS', None)
 
2140
        self.overrideEnv('COLUMNS', None)
 
2141
        self.replace_stdout(None)
 
2142
        self.assertEqual(None, osutils.terminal_width())
 
2143
 
 
2144
    def test_no_TIOCGWINSZ(self):
 
2145
        self.requireFeature(term_ios_feature)
 
2146
        termios = term_ios_feature.module
 
2147
        # bug 63539 is about a termios without TIOCGWINSZ attribute
 
2148
        try:
 
2149
            orig = termios.TIOCGWINSZ
 
2150
        except AttributeError:
 
2151
            # We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
 
2152
            pass
 
2153
        else:
 
2154
            self.overrideAttr(termios, 'TIOCGWINSZ')
 
2155
            del termios.TIOCGWINSZ
 
2156
        self.overrideEnv('BZR_COLUMNS', None)
 
2157
        self.overrideEnv('COLUMNS', None)
 
2158
        # Whatever the result is, if we don't raise an exception, it's ok.
 
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")))