← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_osutils.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Tests for the osutils wrapper."""
18
18
 
19
 
from cStringIO import StringIO
20
19
import errno
21
20
import os
22
 
import re
23
21
import socket
 
22
import stat
24
23
import sys
25
 
import time
26
24
 
 
25
import bzrlib
27
26
from bzrlib import (
28
27
    errors,
29
 
    lazy_regex,
30
28
    osutils,
31
 
    symbol_versioning,
32
 
    tests,
33
 
    trace,
34
29
    win32utils,
35
30
    )
 
31
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
36
32
from bzrlib.tests import (
37
 
    features,
38
 
    file_utils,
39
 
    test__walkdirs_win32,
40
 
    )
41
 
 
42
 
 
43
 
class _UTF8DirReaderFeature(tests.Feature):
44
 
 
45
 
    def _probe(self):
46
 
        try:
47
 
            from bzrlib import _readdir_pyx
48
 
            self.reader = _readdir_pyx.UTF8DirReader
49
 
            return True
50
 
        except ImportError:
51
 
            return False
52
 
 
53
 
    def feature_name(self):
54
 
        return 'bzrlib._readdir_pyx'
55
 
 
56
 
UTF8DirReaderFeature = _UTF8DirReaderFeature()
57
 
 
58
 
term_ios_feature = tests.ModuleAvailableFeature('termios')
59
 
 
60
 
 
61
 
def _already_unicode(s):
62
 
    return s
63
 
 
64
 
 
65
 
def _utf8_to_unicode(s):
66
 
    return s.decode('UTF-8')
67
 
 
68
 
 
69
 
def dir_reader_scenarios():
70
 
    # For each dir reader we define:
71
 
 
72
 
    # - native_to_unicode: a function converting the native_abspath as returned
73
 
    #   by DirReader.read_dir to its unicode representation
74
 
 
75
 
    # UnicodeDirReader is the fallback, it should be tested on all platforms.
76
 
    scenarios = [('unicode',
77
 
                  dict(_dir_reader_class=osutils.UnicodeDirReader,
78
 
                       _native_to_unicode=_already_unicode))]
79
 
    # Some DirReaders are platform specific and even there they may not be
80
 
    # available.
81
 
    if UTF8DirReaderFeature.available():
82
 
        from bzrlib import _readdir_pyx
83
 
        scenarios.append(('utf8',
84
 
                          dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
85
 
                               _native_to_unicode=_utf8_to_unicode)))
86
 
 
87
 
    if test__walkdirs_win32.win32_readdir_feature.available():
88
 
        try:
89
 
            from bzrlib import _walkdirs_win32
90
 
            scenarios.append(
91
 
                ('win32',
92
 
                 dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
93
 
                      _native_to_unicode=_already_unicode)))
94
 
        except ImportError:
95
 
            pass
96
 
    return scenarios
97
 
 
98
 
 
99
 
def load_tests(basic_tests, module, loader):
100
 
    suite = loader.suiteClass()
101
 
    dir_reader_tests, remaining_tests = tests.split_suite_by_condition(
102
 
        basic_tests, tests.condition_isinstance(TestDirReader))
103
 
    tests.multiply_tests(dir_reader_tests, dir_reader_scenarios(), suite)
104
 
    suite.addTest(remaining_tests)
105
 
    return suite
106
 
 
107
 
 
108
 
class TestContainsWhitespace(tests.TestCase):
 
33
        StringIOWrapper,
 
34
        TestCase, 
 
35
        TestCaseInTempDir, 
 
36
        TestSkipped,
 
37
        )
 
38
 
 
39
 
 
40
class TestOSUtils(TestCaseInTempDir):
109
41
 
110
42
    def test_contains_whitespace(self):
111
43
        self.failUnless(osutils.contains_whitespace(u' '))
121
53
        self.failIf(osutils.contains_whitespace(u'hellothere'))
122
54
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
123
55
 
124
 
 
125
 
class TestRename(tests.TestCaseInTempDir):
126
 
 
127
 
    def create_file(self, filename, content):
128
 
        f = open(filename, 'wb')
129
 
        try:
130
 
            f.write(content)
131
 
        finally:
132
 
            f.close()
133
 
 
134
 
    def _fancy_rename(self, a, b):
135
 
        osutils.fancy_rename(a, b, rename_func=os.rename,
136
 
                             unlink_func=os.unlink)
137
 
 
138
56
    def test_fancy_rename(self):
139
57
        # This should work everywhere
140
 
        self.create_file('a', 'something in a\n')
141
 
        self._fancy_rename('a', 'b')
 
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')
142
65
        self.failIfExists('a')
143
66
        self.failUnlessExists('b')
144
67
        self.check_file_contents('b', 'something in a\n')
145
68
 
146
 
        self.create_file('a', 'new something in a\n')
147
 
        self._fancy_rename('b', 'a')
 
69
        open('a', 'wb').write('new something in a\n')
 
70
        rename('b', 'a')
148
71
 
149
72
        self.check_file_contents('a', 'something in a\n')
150
73
 
151
 
    def test_fancy_rename_fails_source_missing(self):
152
 
        # An exception should be raised, and the target should be left in place
153
 
        self.create_file('target', 'data in target\n')
154
 
        self.assertRaises((IOError, OSError), self._fancy_rename,
155
 
                          'missingsource', 'target')
156
 
        self.failUnlessExists('target')
157
 
        self.check_file_contents('target', 'data in target\n')
158
 
 
159
 
    def test_fancy_rename_fails_if_source_and_target_missing(self):
160
 
        self.assertRaises((IOError, OSError), self._fancy_rename,
161
 
                          'missingsource', 'missingtarget')
162
 
 
163
74
    def test_rename(self):
164
75
        # Rename should be semi-atomic on all platforms
165
 
        self.create_file('a', 'something in a\n')
 
76
        open('a', 'wb').write('something in a\n')
166
77
        osutils.rename('a', 'b')
167
78
        self.failIfExists('a')
168
79
        self.failUnlessExists('b')
169
80
        self.check_file_contents('b', 'something in a\n')
170
81
 
171
 
        self.create_file('a', 'new something in a\n')
 
82
        open('a', 'wb').write('new something in a\n')
172
83
        osutils.rename('b', 'a')
173
84
 
174
85
        self.check_file_contents('a', 'something in a\n')
175
86
 
176
87
    # TODO: test fancy_rename using a MemoryTransport
177
88
 
178
 
    def test_rename_change_case(self):
179
 
        # on Windows we should be able to change filename case by rename
180
 
        self.build_tree(['a', 'b/'])
181
 
        osutils.rename('a', 'A')
182
 
        osutils.rename('b', 'B')
183
 
        # we can't use failUnlessExists on case-insensitive filesystem
184
 
        # so try to check shape of the tree
185
 
        shape = sorted(os.listdir('.'))
186
 
        self.assertEquals(['A', 'B'], shape)
187
 
 
188
 
 
189
 
class TestRandChars(tests.TestCase):
190
 
 
191
89
    def test_01_rand_chars_empty(self):
192
90
        result = osutils.rand_chars(0)
193
91
        self.assertEqual(result, '')
198
96
        self.assertEqual(type(result), str)
199
97
        self.assertContainsRe(result, r'^[a-z0-9]{100}$')
200
98
 
201
 
 
202
 
class TestIsInside(tests.TestCase):
203
 
 
204
99
    def test_is_inside(self):
205
100
        is_inside = osutils.is_inside
206
101
        self.assertTrue(is_inside('src', 'src/foo.c'))
210
105
        self.assertFalse(is_inside('foo.c', ''))
211
106
        self.assertTrue(is_inside('', 'foo.c'))
212
107
 
213
 
    def test_is_inside_any(self):
214
 
        SRC_FOO_C = osutils.pathjoin('src', 'foo.c')
215
 
        for dirs, fn in [(['src', 'doc'], SRC_FOO_C),
216
 
                         (['src'], SRC_FOO_C),
217
 
                         (['src'], 'src'),
218
 
                         ]:
219
 
            self.assert_(osutils.is_inside_any(dirs, fn))
220
 
        for dirs, fn in [(['src'], 'srccontrol'),
221
 
                         (['src'], 'srccontrol/foo')]:
222
 
            self.assertFalse(osutils.is_inside_any(dirs, fn))
223
 
 
224
 
    def test_is_inside_or_parent_of_any(self):
225
 
        for dirs, fn in [(['src', 'doc'], 'src/foo.c'),
226
 
                         (['src'], 'src/foo.c'),
227
 
                         (['src/bar.c'], 'src'),
228
 
                         (['src/bar.c', 'bla/foo.c'], 'src'),
229
 
                         (['src'], 'src'),
230
 
                         ]:
231
 
            self.assert_(osutils.is_inside_or_parent_of_any(dirs, fn))
232
 
 
233
 
        for dirs, fn in [(['src'], 'srccontrol'),
234
 
                         (['srccontrol/foo.c'], 'src'),
235
 
                         (['src'], 'srccontrol/foo')]:
236
 
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
237
 
 
238
 
 
239
 
class TestRmTree(tests.TestCaseInTempDir):
240
 
 
241
108
    def test_rmtree(self):
242
109
        # Check to remove tree with read-only files/dirs
243
110
        os.mkdir('dir')
256
123
        self.failIfExists('dir/file')
257
124
        self.failIfExists('dir')
258
125
 
259
 
 
260
 
class TestDeleteAny(tests.TestCaseInTempDir):
261
 
 
262
 
    def test_delete_any_readonly(self):
263
 
        # from <https://bugs.launchpad.net/bzr/+bug/218206>
264
 
        self.build_tree(['d/', 'f'])
265
 
        osutils.make_readonly('d')
266
 
        osutils.make_readonly('f')
267
 
 
268
 
        osutils.delete_any('f')
269
 
        osutils.delete_any('d')
270
 
 
271
 
 
272
 
class TestKind(tests.TestCaseInTempDir):
273
 
 
274
126
    def test_file_kind(self):
275
127
        self.build_tree(['file', 'dir/'])
276
128
        self.assertEquals('file', osutils.file_kind('file'))
278
130
        if osutils.has_symlinks():
279
131
            os.symlink('symlink', 'symlink')
280
132
            self.assertEquals('symlink', osutils.file_kind('symlink'))
281
 
 
 
133
        
282
134
        # TODO: jam 20060529 Test a block device
283
135
        try:
284
136
            os.lstat('/dev/null')
306
158
                os.remove('socket')
307
159
 
308
160
    def test_kind_marker(self):
309
 
        self.assertEqual("", osutils.kind_marker("file"))
310
 
        self.assertEqual("/", osutils.kind_marker('directory'))
311
 
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
312
 
        self.assertEqual("@", osutils.kind_marker("symlink"))
313
 
        self.assertEqual("+", osutils.kind_marker("tree-reference"))
314
 
        self.assertEqual("", osutils.kind_marker("fifo"))
315
 
        self.assertEqual("", osutils.kind_marker("socket"))
316
 
        self.assertEqual("", osutils.kind_marker("unknown"))
317
 
 
318
 
 
319
 
class TestUmask(tests.TestCaseInTempDir):
 
161
        self.assertEqual(osutils.kind_marker('file'), '')
 
162
        self.assertEqual(osutils.kind_marker('directory'), '/')
 
163
        self.assertEqual(osutils.kind_marker('symlink'), '@')
 
164
        self.assertEqual(osutils.kind_marker('tree-reference'), '+')
320
165
 
321
166
    def test_get_umask(self):
322
167
        if sys.platform == 'win32':
325
170
            return
326
171
 
327
172
        orig_umask = osutils.get_umask()
328
 
        self.addCleanup(os.umask, orig_umask)
329
 
        os.umask(0222)
330
 
        self.assertEqual(0222, osutils.get_umask())
331
 
        os.umask(0022)
332
 
        self.assertEqual(0022, osutils.get_umask())
333
 
        os.umask(0002)
334
 
        self.assertEqual(0002, osutils.get_umask())
335
 
        os.umask(0027)
336
 
        self.assertEqual(0027, osutils.get_umask())
337
 
 
338
 
 
339
 
class TestDateTime(tests.TestCase):
 
173
        try:
 
174
            os.umask(0222)
 
175
            self.assertEqual(0222, osutils.get_umask())
 
176
            os.umask(0022)
 
177
            self.assertEqual(0022, osutils.get_umask())
 
178
            os.umask(0002)
 
179
            self.assertEqual(0002, osutils.get_umask())
 
180
            os.umask(0027)
 
181
            self.assertEqual(0027, osutils.get_umask())
 
182
        finally:
 
183
            os.umask(orig_umask)
340
184
 
341
185
    def assertFormatedDelta(self, expected, seconds):
342
186
        """Assert osutils.format_delta formats as expected"""
374
218
        self.assertFormatedDelta('1 second in the future', -1)
375
219
        self.assertFormatedDelta('2 seconds in the future', -2)
376
220
 
377
 
    def test_format_date(self):
378
 
        self.assertRaises(errors.UnsupportedTimezoneFormat,
379
 
            osutils.format_date, 0, timezone='foo')
380
 
        self.assertIsInstance(osutils.format_date(0), str)
381
 
        self.assertIsInstance(osutils.format_local_date(0), unicode)
382
 
        # Testing for the actual value of the local weekday without
383
 
        # duplicating the code from format_date is difficult.
384
 
        # Instead blackbox.test_locale should check for localized
385
 
        # dates once they do occur in output strings.
386
 
 
387
 
    def test_format_date_with_offset_in_original_timezone(self):
388
 
        self.assertEqual("Thu 1970-01-01 00:00:00 +0000",
389
 
            osutils.format_date_with_offset_in_original_timezone(0))
390
 
        self.assertEqual("Fri 1970-01-02 03:46:40 +0000",
391
 
            osutils.format_date_with_offset_in_original_timezone(100000))
392
 
        self.assertEqual("Fri 1970-01-02 05:46:40 +0200",
393
 
            osutils.format_date_with_offset_in_original_timezone(100000, 7200))
394
 
 
395
 
    def test_local_time_offset(self):
396
 
        """Test that local_time_offset() returns a sane value."""
397
 
        offset = osutils.local_time_offset()
398
 
        self.assertTrue(isinstance(offset, int))
399
 
        # Test that the offset is no more than a eighteen hours in
400
 
        # either direction.
401
 
        # Time zone handling is system specific, so it is difficult to
402
 
        # do more specific tests, but a value outside of this range is
403
 
        # probably wrong.
404
 
        eighteen_hours = 18 * 3600
405
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
406
 
 
407
 
    def test_local_time_offset_with_timestamp(self):
408
 
        """Test that local_time_offset() works with a timestamp."""
409
 
        offset = osutils.local_time_offset(1000000000.1234567)
410
 
        self.assertTrue(isinstance(offset, int))
411
 
        eighteen_hours = 18 * 3600
412
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
413
 
 
414
 
 
415
 
class TestLinks(tests.TestCaseInTempDir):
416
 
 
417
221
    def test_dereference_path(self):
418
 
        self.requireFeature(tests.SymlinkFeature)
 
222
        if not osutils.has_symlinks():
 
223
            raise TestSkipped('Symlinks are not supported on this platform')
419
224
        cwd = osutils.realpath('.')
420
225
        os.mkdir('bar')
421
226
        bar_path = osutils.pathjoin(cwd, 'bar')
424
229
        self.assertEqual(bar_path, osutils.realpath('./bar'))
425
230
        os.symlink('bar', 'foo')
426
231
        self.assertEqual(bar_path, osutils.realpath('./foo'))
427
 
 
 
232
        
428
233
        # Does not dereference terminal symlinks
429
234
        foo_path = osutils.pathjoin(cwd, 'foo')
430
235
        self.assertEqual(foo_path, osutils.dereference_path('./foo'))
441
246
        foo_baz_path = osutils.pathjoin(foo_path, 'baz')
442
247
        self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
443
248
 
 
249
 
444
250
    def test_changing_access(self):
445
251
        f = file('file', 'w')
446
252
        f.write('monkey')
448
254
 
449
255
        # Make a file readonly
450
256
        osutils.make_readonly('file')
451
 
        mode = os.lstat('file').st_mode
 
257
        mode = osutils.lstat('file').st_mode
452
258
        self.assertEqual(mode, mode & 0777555)
453
259
 
454
260
        # Make a file writable
455
261
        osutils.make_writable('file')
456
 
        mode = os.lstat('file').st_mode
 
262
        mode = osutils.lstat('file').st_mode
457
263
        self.assertEqual(mode, mode | 0200)
458
264
 
459
265
        if osutils.has_symlinks():
462
268
            osutils.make_readonly('dangling')
463
269
            osutils.make_writable('dangling')
464
270
 
465
 
    def test_host_os_dereferences_symlinks(self):
466
 
        osutils.host_os_dereferences_symlinks()
467
 
 
468
 
 
469
 
class TestCanonicalRelPath(tests.TestCaseInTempDir):
470
 
 
471
 
    _test_needs_features = [tests.CaseInsCasePresFilenameFeature]
472
 
 
473
 
    def test_canonical_relpath_simple(self):
474
 
        f = file('MixedCaseName', 'w')
475
 
        f.close()
476
 
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
477
 
        self.failUnlessEqual('work/MixedCaseName', actual)
478
 
 
479
 
    def test_canonical_relpath_missing_tail(self):
480
 
        os.mkdir('MixedCaseParent')
481
 
        actual = osutils.canonical_relpath(self.test_base_dir,
482
 
                                           'mixedcaseparent/nochild')
483
 
        self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
484
 
 
485
 
 
486
 
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
487
 
 
488
 
    def assertRelpath(self, expected, base, path):
489
 
        actual = osutils._cicp_canonical_relpath(base, path)
490
 
        self.assertEqual(expected, actual)
491
 
 
492
 
    def test_simple(self):
493
 
        self.build_tree(['MixedCaseName'])
494
 
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
495
 
        self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
496
 
 
497
 
    def test_subdir_missing_tail(self):
498
 
        self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
499
 
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
500
 
        self.assertRelpath('MixedCaseParent/a_child', base,
501
 
                           'MixedCaseParent/a_child')
502
 
        self.assertRelpath('MixedCaseParent/a_child', base,
503
 
                           'MixedCaseParent/A_Child')
504
 
        self.assertRelpath('MixedCaseParent/not_child', base,
505
 
                           'MixedCaseParent/not_child')
506
 
 
507
 
    def test_at_root_slash(self):
508
 
        # We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
509
 
        # check...
510
 
        if osutils.MIN_ABS_PATHLENGTH > 1:
511
 
            raise tests.TestSkipped('relpath requires %d chars'
512
 
                                    % osutils.MIN_ABS_PATHLENGTH)
513
 
        self.assertRelpath('foo', '/', '/foo')
514
 
 
515
 
    def test_at_root_drive(self):
516
 
        if sys.platform != 'win32':
517
 
            raise tests.TestNotApplicable('we can only test drive-letter relative'
518
 
                                          ' paths on Windows where we have drive'
519
 
                                          ' letters.')
520
 
        # see bug #322807
521
 
        # The specific issue is that when at the root of a drive, 'abspath'
522
 
        # returns "C:/" or just "/". However, the code assumes that abspath
523
 
        # always returns something like "C:/foo" or "/foo" (no trailing slash).
524
 
        self.assertRelpath('foo', 'C:/', 'C:/foo')
525
 
        self.assertRelpath('foo', 'X:/', 'X:/foo')
526
 
        self.assertRelpath('foo', 'X:/', 'X://foo')
527
 
 
528
 
 
529
 
class TestPumpFile(tests.TestCase):
530
 
    """Test pumpfile method."""
531
 
 
532
 
    def setUp(self):
533
 
        tests.TestCase.setUp(self)
534
 
        # create a test datablock
535
 
        self.block_size = 512
536
 
        pattern = '0123456789ABCDEF'
537
 
        self.test_data = pattern * (3 * self.block_size / len(pattern))
538
 
        self.test_data_len = len(self.test_data)
539
 
 
540
 
    def test_bracket_block_size(self):
541
 
        """Read data in blocks with the requested read size bracketing the
542
 
        block size."""
543
 
        # make sure test data is larger than max read size
544
 
        self.assertTrue(self.test_data_len > self.block_size)
545
 
 
546
 
        from_file = file_utils.FakeReadFile(self.test_data)
547
 
        to_file = StringIO()
548
 
 
549
 
        # read (max / 2) bytes and verify read size wasn't affected
550
 
        num_bytes_to_read = self.block_size / 2
551
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
552
 
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
553
 
        self.assertEqual(from_file.get_read_count(), 1)
554
 
 
555
 
        # read (max) bytes and verify read size wasn't affected
556
 
        num_bytes_to_read = self.block_size
557
 
        from_file.reset_read_count()
558
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
559
 
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
560
 
        self.assertEqual(from_file.get_read_count(), 1)
561
 
 
562
 
        # read (max + 1) bytes and verify read size was limited
563
 
        num_bytes_to_read = self.block_size + 1
564
 
        from_file.reset_read_count()
565
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
566
 
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
567
 
        self.assertEqual(from_file.get_read_count(), 2)
568
 
 
569
 
        # finish reading the rest of the data
570
 
        num_bytes_to_read = self.test_data_len - to_file.tell()
571
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
572
 
 
573
 
        # report error if the data wasn't equal (we only report the size due
574
 
        # to the length of the data)
575
 
        response_data = to_file.getvalue()
576
 
        if response_data != self.test_data:
577
 
            message = "Data not equal.  Expected %d bytes, received %d."
578
 
            self.fail(message % (len(response_data), self.test_data_len))
579
 
 
580
 
    def test_specified_size(self):
581
 
        """Request a transfer larger than the maximum block size and verify
582
 
        that the maximum read doesn't exceed the block_size."""
583
 
        # make sure test data is larger than max read size
584
 
        self.assertTrue(self.test_data_len > self.block_size)
585
 
 
586
 
        # retrieve data in blocks
587
 
        from_file = file_utils.FakeReadFile(self.test_data)
588
 
        to_file = StringIO()
589
 
        osutils.pumpfile(from_file, to_file, self.test_data_len,
590
 
                         self.block_size)
591
 
 
592
 
        # verify read size was equal to the maximum read size
593
 
        self.assertTrue(from_file.get_max_read_size() > 0)
594
 
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
595
 
        self.assertEqual(from_file.get_read_count(), 3)
596
 
 
597
 
        # report error if the data wasn't equal (we only report the size due
598
 
        # to the length of the data)
599
 
        response_data = to_file.getvalue()
600
 
        if response_data != self.test_data:
601
 
            message = "Data not equal.  Expected %d bytes, received %d."
602
 
            self.fail(message % (len(response_data), self.test_data_len))
603
 
 
604
 
    def test_to_eof(self):
605
 
        """Read to end-of-file and verify that the reads are not larger than
606
 
        the maximum read size."""
607
 
        # make sure test data is larger than max read size
608
 
        self.assertTrue(self.test_data_len > self.block_size)
609
 
 
610
 
        # retrieve data to EOF
611
 
        from_file = file_utils.FakeReadFile(self.test_data)
612
 
        to_file = StringIO()
613
 
        osutils.pumpfile(from_file, to_file, -1, self.block_size)
614
 
 
615
 
        # verify read size was equal to the maximum read size
616
 
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
617
 
        self.assertEqual(from_file.get_read_count(), 4)
618
 
 
619
 
        # report error if the data wasn't equal (we only report the size due
620
 
        # to the length of the data)
621
 
        response_data = to_file.getvalue()
622
 
        if response_data != self.test_data:
623
 
            message = "Data not equal.  Expected %d bytes, received %d."
624
 
            self.fail(message % (len(response_data), self.test_data_len))
625
 
 
626
 
    def test_defaults(self):
627
 
        """Verifies that the default arguments will read to EOF -- this
628
 
        test verifies that any existing usages of pumpfile will not be broken
629
 
        with this new version."""
630
 
        # retrieve data using default (old) pumpfile method
631
 
        from_file = file_utils.FakeReadFile(self.test_data)
632
 
        to_file = StringIO()
633
 
        osutils.pumpfile(from_file, to_file)
634
 
 
635
 
        # report error if the data wasn't equal (we only report the size due
636
 
        # to the length of the data)
637
 
        response_data = to_file.getvalue()
638
 
        if response_data != self.test_data:
639
 
            message = "Data not equal.  Expected %d bytes, received %d."
640
 
            self.fail(message % (len(response_data), self.test_data_len))
641
 
 
642
 
    def test_report_activity(self):
643
 
        activity = []
644
 
        def log_activity(length, direction):
645
 
            activity.append((length, direction))
646
 
        from_file = StringIO(self.test_data)
647
 
        to_file = StringIO()
648
 
        osutils.pumpfile(from_file, to_file, buff_size=500,
649
 
                         report_activity=log_activity, direction='read')
650
 
        self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
651
 
                          (36, 'read')], activity)
652
 
 
653
 
        from_file = StringIO(self.test_data)
654
 
        to_file = StringIO()
655
 
        del activity[:]
656
 
        osutils.pumpfile(from_file, to_file, buff_size=500,
657
 
                         report_activity=log_activity, direction='write')
658
 
        self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
659
 
                          (36, 'write')], activity)
660
 
 
661
 
        # And with a limited amount of data
662
 
        from_file = StringIO(self.test_data)
663
 
        to_file = StringIO()
664
 
        del activity[:]
665
 
        osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
666
 
                         report_activity=log_activity, direction='read')
667
 
        self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
668
 
 
669
 
 
670
 
 
671
 
class TestPumpStringFile(tests.TestCase):
672
 
 
673
 
    def test_empty(self):
674
 
        output = StringIO()
675
 
        osutils.pump_string_file("", output)
676
 
        self.assertEqual("", output.getvalue())
677
 
 
678
 
    def test_more_than_segment_size(self):
679
 
        output = StringIO()
680
 
        osutils.pump_string_file("123456789", output, 2)
681
 
        self.assertEqual("123456789", output.getvalue())
682
 
 
683
 
    def test_segment_size(self):
684
 
        output = StringIO()
685
 
        osutils.pump_string_file("12", output, 2)
686
 
        self.assertEqual("12", output.getvalue())
687
 
 
688
 
    def test_segment_size_multiple(self):
689
 
        output = StringIO()
690
 
        osutils.pump_string_file("1234", output, 2)
691
 
        self.assertEqual("1234", output.getvalue())
692
 
 
693
 
 
694
 
class TestRelpath(tests.TestCase):
695
 
 
696
 
    def test_simple_relpath(self):
697
 
        cwd = osutils.getcwd()
698
 
        subdir = cwd + '/subdir'
699
 
        self.assertEqual('subdir', osutils.relpath(cwd, subdir))
700
 
 
701
 
    def test_deep_relpath(self):
702
 
        cwd = osutils.getcwd()
703
 
        subdir = cwd + '/sub/subsubdir'
704
 
        self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
705
 
 
706
 
    def test_not_relative(self):
707
 
        self.assertRaises(errors.PathNotChild,
708
 
                          osutils.relpath, 'C:/path', 'H:/path')
709
 
        self.assertRaises(errors.PathNotChild,
710
 
                          osutils.relpath, 'C:/', 'H:/path')
711
 
 
712
 
 
713
 
class TestSafeUnicode(tests.TestCase):
 
271
 
 
272
    def test_kind_marker(self):
 
273
        self.assertEqual("", osutils.kind_marker("file"))
 
274
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
 
275
        self.assertEqual("@", osutils.kind_marker("symlink"))
 
276
        self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
 
277
 
 
278
 
 
279
class TestSafeUnicode(TestCase):
714
280
 
715
281
    def test_from_ascii_string(self):
716
282
        self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
725
291
        self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
726
292
 
727
293
    def test_bad_utf8_string(self):
728
 
        self.assertRaises(errors.BzrBadParameterNotUnicode,
 
294
        self.assertRaises(BzrBadParameterNotUnicode,
729
295
                          osutils.safe_unicode,
730
296
                          '\xbb\xbb')
731
297
 
732
298
 
733
 
class TestSafeUtf8(tests.TestCase):
 
299
class TestSafeUtf8(TestCase):
734
300
 
735
301
    def test_from_ascii_string(self):
736
302
        f = 'foobar'
746
312
        self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
747
313
 
748
314
    def test_bad_utf8_string(self):
749
 
        self.assertRaises(errors.BzrBadParameterNotUnicode,
 
315
        self.assertRaises(BzrBadParameterNotUnicode,
750
316
                          osutils.safe_utf8, '\xbb\xbb')
751
317
 
752
318
 
753
 
class TestSafeRevisionId(tests.TestCase):
 
319
class TestSafeRevisionId(TestCase):
754
320
 
755
321
    def test_from_ascii_string(self):
756
 
        # this shouldn't give a warning because it's getting an ascii string
757
322
        self.assertEqual('foobar', osutils.safe_revision_id('foobar'))
758
323
 
759
324
    def test_from_unicode_string_ascii_contents(self):
778
343
        self.assertEqual(None, osutils.safe_revision_id(None))
779
344
 
780
345
 
781
 
class TestSafeFileId(tests.TestCase):
 
346
class TestSafeFileId(TestCase):
782
347
 
783
348
    def test_from_ascii_string(self):
784
349
        self.assertEqual('foobar', osutils.safe_file_id('foobar'))
804
369
        self.assertEqual(None, osutils.safe_file_id(None))
805
370
 
806
371
 
807
 
class TestWin32Funcs(tests.TestCase):
808
 
    """Test that _win32 versions of os utilities return appropriate paths."""
 
372
class TestWin32Funcs(TestCase):
 
373
    """Test that the _win32 versions of os utilities return appropriate paths."""
809
374
 
810
375
    def test_abspath(self):
811
376
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
818
383
        self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
819
384
 
820
385
    def test_pathjoin(self):
821
 
        self.assertEqual('path/to/foo',
822
 
                         osutils._win32_pathjoin('path', 'to', 'foo'))
823
 
        self.assertEqual('C:/foo',
824
 
                         osutils._win32_pathjoin('path\\to', 'C:\\foo'))
825
 
        self.assertEqual('C:/foo',
826
 
                         osutils._win32_pathjoin('path/to', 'C:/foo'))
827
 
        self.assertEqual('path/to/foo',
828
 
                         osutils._win32_pathjoin('path/to/', 'foo'))
829
 
        self.assertEqual('/foo',
830
 
                         osutils._win32_pathjoin('C:/path/to/', '/foo'))
831
 
        self.assertEqual('/foo',
832
 
                         osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
 
386
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path', 'to', 'foo'))
 
387
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path\\to', 'C:\\foo'))
 
388
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path/to', 'C:/foo'))
 
389
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path/to/', 'foo'))
 
390
        self.assertEqual('/foo', osutils._win32_pathjoin('C:/path/to/', '/foo'))
 
391
        self.assertEqual('/foo', osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
833
392
 
834
393
    def test_normpath(self):
835
 
        self.assertEqual('path/to/foo',
836
 
                         osutils._win32_normpath(r'path\\from\..\to\.\foo'))
837
 
        self.assertEqual('path/to/foo',
838
 
                         osutils._win32_normpath('path//from/../to/./foo'))
 
394
        self.assertEqual('path/to/foo', osutils._win32_normpath(r'path\\from\..\to\.\foo'))
 
395
        self.assertEqual('path/to/foo', osutils._win32_normpath('path//from/../to/./foo'))
839
396
 
840
397
    def test_getcwd(self):
841
398
        cwd = osutils._win32_getcwd()
862
419
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
863
420
        # relative path
864
421
        cwd = osutils.getcwd().rstrip('/')
865
 
        drive = osutils.ntpath.splitdrive(cwd)[0]
 
422
        drive = osutils._nt_splitdrive(cwd)[0]
866
423
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
867
424
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
868
425
        # unicode path
870
427
        self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
871
428
 
872
429
 
873
 
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
 
430
class TestWin32FuncsDirs(TestCaseInTempDir):
874
431
    """Test win32 functions that create files."""
 
432
    
 
433
    def test_getcwd(self):
 
434
        if win32utils.winver == 'Windows 98':
 
435
            raise TestSkipped('Windows 98 cannot handle unicode filenames')
 
436
        # Make sure getcwd can handle unicode filenames
 
437
        try:
 
438
            os.mkdir(u'mu-\xb5')
 
439
        except UnicodeError:
 
440
            raise TestSkipped("Unable to create Unicode filename")
875
441
 
876
 
    def test_getcwd(self):
877
 
        self.requireFeature(tests.UnicodeFilenameFeature)
878
 
        os.mkdir(u'mu-\xb5')
879
442
        os.chdir(u'mu-\xb5')
880
443
        # TODO: jam 20060427 This will probably fail on Mac OSX because
881
444
        #       it will change the normalization of B\xe5gfors
883
446
        #       osutils.getcwd() renormalize the path.
884
447
        self.assertEndsWith(osutils._win32_getcwd(), u'mu-\xb5')
885
448
 
886
 
    def test_minimum_path_selection(self):
887
 
        self.assertEqual(set(),
888
 
            osutils.minimum_path_selection([]))
889
 
        self.assertEqual(set(['a']),
890
 
            osutils.minimum_path_selection(['a']))
891
 
        self.assertEqual(set(['a', 'b']),
892
 
            osutils.minimum_path_selection(['a', 'b']))
893
 
        self.assertEqual(set(['a/', 'b']),
894
 
            osutils.minimum_path_selection(['a/', 'b']))
895
 
        self.assertEqual(set(['a/', 'b']),
896
 
            osutils.minimum_path_selection(['a/c', 'a/', 'b']))
897
 
        self.assertEqual(set(['a-b', 'a', 'a0b']),
898
 
            osutils.minimum_path_selection(['a-b', 'a/b', 'a0b', 'a']))
899
 
 
900
449
    def test_mkdtemp(self):
901
450
        tmpdir = osutils._win32_mkdtemp(dir='.')
902
451
        self.assertFalse('\\' in tmpdir)
957
506
        self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
958
507
 
959
508
 
960
 
class TestParentDirectories(tests.TestCaseInTempDir):
961
 
    """Test osutils.parent_directories()"""
962
 
 
963
 
    def test_parent_directories(self):
964
 
        self.assertEqual([], osutils.parent_directories('a'))
965
 
        self.assertEqual(['a'], osutils.parent_directories('a/b'))
966
 
        self.assertEqual(['a/b', 'a'], osutils.parent_directories('a/b/c'))
967
 
 
968
 
 
969
 
class TestMacFuncsDirs(tests.TestCaseInTempDir):
 
509
class TestMacFuncsDirs(TestCaseInTempDir):
970
510
    """Test mac special functions that require directories."""
971
511
 
972
512
    def test_getcwd(self):
973
 
        self.requireFeature(tests.UnicodeFilenameFeature)
974
 
        os.mkdir(u'B\xe5gfors')
 
513
        # On Mac, this will actually create Ba\u030agfors
 
514
        # but chdir will still work, because it accepts both paths
 
515
        try:
 
516
            os.mkdir(u'B\xe5gfors')
 
517
        except UnicodeError:
 
518
            raise TestSkipped("Unable to create Unicode filename")
 
519
 
975
520
        os.chdir(u'B\xe5gfors')
976
521
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
977
522
 
978
523
    def test_getcwd_nonnorm(self):
979
 
        self.requireFeature(tests.UnicodeFilenameFeature)
980
524
        # Test that _mac_getcwd() will normalize this path
981
 
        os.mkdir(u'Ba\u030agfors')
 
525
        try:
 
526
            os.mkdir(u'Ba\u030agfors')
 
527
        except UnicodeError:
 
528
            raise TestSkipped("Unable to create Unicode filename")
 
529
 
982
530
        os.chdir(u'Ba\u030agfors')
983
531
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
984
532
 
985
533
 
986
 
class TestChunksToLines(tests.TestCase):
987
 
 
988
 
    def test_smoketest(self):
989
 
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
990
 
                         osutils.chunks_to_lines(['foo\nbar', '\nbaz\n']))
991
 
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
992
 
                         osutils.chunks_to_lines(['foo\n', 'bar\n', 'baz\n']))
993
 
 
994
 
    def test_osutils_binding(self):
995
 
        from bzrlib.tests import test__chunks_to_lines
996
 
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
997
 
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
998
 
        else:
999
 
            from bzrlib._chunks_to_lines_py import chunks_to_lines
1000
 
        self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
1001
 
 
1002
 
 
1003
 
class TestSplitLines(tests.TestCase):
 
534
class TestSplitLines(TestCase):
1004
535
 
1005
536
    def test_split_unicode(self):
1006
537
        self.assertEqual([u'foo\n', u'bar\xae'],
1013
544
                         osutils.split_lines('foo\rbar\n'))
1014
545
 
1015
546
 
1016
 
class TestWalkDirs(tests.TestCaseInTempDir):
1017
 
 
1018
 
    def assertExpectedBlocks(self, expected, result):
1019
 
        self.assertEqual(expected,
1020
 
                         [(dirinfo, [line[0:3] for line in block])
1021
 
                          for dirinfo, block in result])
 
547
class TestWalkDirs(TestCaseInTempDir):
1022
548
 
1023
549
    def test_walkdirs(self):
1024
550
        tree = [
1057
583
            result.append((dirdetail, dirblock))
1058
584
 
1059
585
        self.assertTrue(found_bzrdir)
1060
 
        self.assertExpectedBlocks(expected_dirblocks, result)
 
586
        self.assertEqual(expected_dirblocks,
 
587
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1061
588
        # you can search a subdir only, with a supplied prefix.
1062
589
        result = []
1063
590
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
1064
591
            result.append(dirblock)
1065
 
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
1066
 
 
1067
 
    def test_walkdirs_os_error(self):
1068
 
        # <https://bugs.launchpad.net/bzr/+bug/338653>
1069
 
        # Pyrex readdir didn't raise useful messages if it had an error
1070
 
        # reading the directory
1071
 
        if sys.platform == 'win32':
1072
 
            raise tests.TestNotApplicable(
1073
 
                "readdir IOError not tested on win32")
1074
 
        self.requireFeature(features.not_running_as_root)
1075
 
        os.mkdir("test-unreadable")
1076
 
        os.chmod("test-unreadable", 0000)
1077
 
        # must chmod it back so that it can be removed
1078
 
        self.addCleanup(os.chmod, "test-unreadable", 0700)
1079
 
        # The error is not raised until the generator is actually evaluated.
1080
 
        # (It would be ok if it happened earlier but at the moment it
1081
 
        # doesn't.)
1082
 
        e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
1083
 
        self.assertEquals('./test-unreadable', e.filename)
1084
 
        self.assertEquals(errno.EACCES, e.errno)
1085
 
        # Ensure the message contains the file name
1086
 
        self.assertContainsRe(str(e), "\./test-unreadable")
1087
 
 
1088
 
 
1089
 
    def test_walkdirs_encoding_error(self):
1090
 
        # <https://bugs.launchpad.net/bzr/+bug/488519>
1091
 
        # walkdirs didn't raise a useful message when the filenames
1092
 
        # are not using the filesystem's encoding
1093
 
 
1094
 
        # require a bytestring based filesystem
1095
 
        self.requireFeature(tests.ByteStringNamedFilesystem)
1096
 
 
1097
 
        tree = [
1098
 
            '.bzr',
1099
 
            '0file',
1100
 
            '1dir/',
1101
 
            '1dir/0file',
1102
 
            '1dir/1dir/',
1103
 
            '1file'
1104
 
            ]
1105
 
 
1106
 
        self.build_tree(tree)
1107
 
 
1108
 
        # rename the 1file to a latin-1 filename
1109
 
        os.rename("./1file", "\xe8file")
1110
 
 
1111
 
        self._save_platform_info()
1112
 
        win32utils.winver = None # Avoid the win32 detection code
1113
 
        osutils._fs_enc = 'UTF-8'
1114
 
 
1115
 
        # this should raise on error
1116
 
        def attempt():
1117
 
            for dirdetail, dirblock in osutils.walkdirs('.'):
1118
 
                pass
1119
 
 
1120
 
        self.assertRaises(errors.BadFilenameEncoding, attempt)
 
592
        self.assertEqual(expected_dirblocks[1:],
 
593
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1121
594
 
1122
595
    def test__walkdirs_utf8(self):
1123
596
        tree = [
1156
629
            result.append((dirdetail, dirblock))
1157
630
 
1158
631
        self.assertTrue(found_bzrdir)
1159
 
        self.assertExpectedBlocks(expected_dirblocks, result)
1160
 
 
 
632
        self.assertEqual(expected_dirblocks,
 
633
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1161
634
        # you can search a subdir only, with a supplied prefix.
1162
635
        result = []
1163
636
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
1164
637
            result.append(dirblock)
1165
 
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
 
638
        self.assertEqual(expected_dirblocks[1:],
 
639
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1166
640
 
1167
641
    def _filter_out_stat(self, result):
1168
642
        """Filter out the stat value from the walkdirs result"""
1173
647
                new_dirblock.append((info[0], info[1], info[2], info[4]))
1174
648
            dirblock[:] = new_dirblock
1175
649
 
1176
 
    def _save_platform_info(self):
1177
 
        self.overrideAttr(win32utils, 'winver')
1178
 
        self.overrideAttr(osutils, '_fs_enc')
1179
 
        self.overrideAttr(osutils, '_selected_dir_reader')
1180
 
 
1181
 
    def assertDirReaderIs(self, expected):
1182
 
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
1183
 
        # Force it to redetect
1184
 
        osutils._selected_dir_reader = None
1185
 
        # Nothing to list, but should still trigger the selection logic
1186
 
        self.assertEqual([(('', '.'), [])], list(osutils._walkdirs_utf8('.')))
1187
 
        self.assertIsInstance(osutils._selected_dir_reader, expected)
1188
 
 
1189
 
    def test_force_walkdirs_utf8_fs_utf8(self):
1190
 
        self.requireFeature(UTF8DirReaderFeature)
1191
 
        self._save_platform_info()
1192
 
        win32utils.winver = None # Avoid the win32 detection code
1193
 
        osutils._fs_enc = 'UTF-8'
1194
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1195
 
 
1196
 
    def test_force_walkdirs_utf8_fs_ascii(self):
1197
 
        self.requireFeature(UTF8DirReaderFeature)
1198
 
        self._save_platform_info()
1199
 
        win32utils.winver = None # Avoid the win32 detection code
1200
 
        osutils._fs_enc = 'US-ASCII'
1201
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1202
 
 
1203
 
    def test_force_walkdirs_utf8_fs_ANSI(self):
1204
 
        self.requireFeature(UTF8DirReaderFeature)
1205
 
        self._save_platform_info()
1206
 
        win32utils.winver = None # Avoid the win32 detection code
1207
 
        osutils._fs_enc = 'ANSI_X3.4-1968'
1208
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1209
 
 
1210
 
    def test_force_walkdirs_utf8_fs_latin1(self):
1211
 
        self._save_platform_info()
1212
 
        win32utils.winver = None # Avoid the win32 detection code
1213
 
        osutils._fs_enc = 'latin1'
1214
 
        self.assertDirReaderIs(osutils.UnicodeDirReader)
1215
 
 
1216
 
    def test_force_walkdirs_utf8_nt(self):
1217
 
        # Disabled because the thunk of the whole walkdirs api is disabled.
1218
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1219
 
        self._save_platform_info()
1220
 
        win32utils.winver = 'Windows NT'
1221
 
        from bzrlib._walkdirs_win32 import Win32ReadDir
1222
 
        self.assertDirReaderIs(Win32ReadDir)
1223
 
 
1224
 
    def test_force_walkdirs_utf8_98(self):
1225
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1226
 
        self._save_platform_info()
1227
 
        win32utils.winver = 'Windows 98'
1228
 
        self.assertDirReaderIs(osutils.UnicodeDirReader)
1229
 
 
1230
650
    def test_unicode_walkdirs(self):
1231
651
        """Walkdirs should always return unicode paths."""
1232
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1233
652
        name0 = u'0file-\xb6'
1234
653
        name1 = u'1dir-\u062c\u0648'
1235
654
        name2 = u'2file-\u0633'
1240
659
            name1 + '/' + name1 + '/',
1241
660
            name2,
1242
661
            ]
1243
 
        self.build_tree(tree)
 
662
        try:
 
663
            self.build_tree(tree)
 
664
        except UnicodeError:
 
665
            raise TestSkipped('Could not represent Unicode chars'
 
666
                              ' in current encoding.')
1244
667
        expected_dirblocks = [
1245
668
                ((u'', u'.'),
1246
669
                 [(name0, name0, 'file', './' + name0),
1272
695
 
1273
696
        The abspath portion might be in unicode or utf-8
1274
697
        """
1275
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1276
698
        name0 = u'0file-\xb6'
1277
699
        name1 = u'1dir-\u062c\u0648'
1278
700
        name2 = u'2file-\u0633'
1283
705
            name1 + '/' + name1 + '/',
1284
706
            name2,
1285
707
            ]
1286
 
        self.build_tree(tree)
 
708
        try:
 
709
            self.build_tree(tree)
 
710
        except UnicodeError:
 
711
            raise TestSkipped('Could not represent Unicode chars'
 
712
                              ' in current encoding.')
1287
713
        name0 = name0.encode('utf8')
1288
714
        name1 = name1.encode('utf8')
1289
715
        name2 = name2.encode('utf8')
1328
754
            result.append((dirdetail, new_dirblock))
1329
755
        self.assertEqual(expected_dirblocks, result)
1330
756
 
1331
 
    def test__walkdirs_utf8_with_unicode_fs(self):
1332
 
        """UnicodeDirReader should be a safe fallback everywhere
 
757
    def test_unicode__walkdirs_unicode_to_utf8(self):
 
758
        """walkdirs_unicode_to_utf8 should be a safe fallback everywhere
1333
759
 
1334
760
        The abspath portion should be in unicode
1335
761
        """
1336
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1337
 
        # Use the unicode reader. TODO: split into driver-and-driven unit
1338
 
        # tests.
1339
 
        self._save_platform_info()
1340
 
        osutils._selected_dir_reader = osutils.UnicodeDirReader()
1341
 
        name0u = u'0file-\xb6'
1342
 
        name1u = u'1dir-\u062c\u0648'
1343
 
        name2u = u'2file-\u0633'
1344
 
        tree = [
1345
 
            name0u,
1346
 
            name1u + '/',
1347
 
            name1u + '/' + name0u,
1348
 
            name1u + '/' + name1u + '/',
1349
 
            name2u,
1350
 
            ]
1351
 
        self.build_tree(tree)
1352
 
        name0 = name0u.encode('utf8')
1353
 
        name1 = name1u.encode('utf8')
1354
 
        name2 = name2u.encode('utf8')
1355
 
 
1356
 
        # All of the abspaths should be in unicode, all of the relative paths
1357
 
        # should be in utf8
1358
 
        expected_dirblocks = [
1359
 
                (('', '.'),
1360
 
                 [(name0, name0, 'file', './' + name0u),
1361
 
                  (name1, name1, 'directory', './' + name1u),
1362
 
                  (name2, name2, 'file', './' + name2u),
1363
 
                 ]
1364
 
                ),
1365
 
                ((name1, './' + name1u),
1366
 
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
1367
 
                                                        + '/' + name0u),
1368
 
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
1369
 
                                                            + '/' + name1u),
1370
 
                 ]
1371
 
                ),
1372
 
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
1373
 
                 [
1374
 
                 ]
1375
 
                ),
1376
 
            ]
1377
 
        result = list(osutils._walkdirs_utf8('.'))
1378
 
        self._filter_out_stat(result)
1379
 
        self.assertEqual(expected_dirblocks, result)
1380
 
 
1381
 
    def test__walkdirs_utf8_win32readdir(self):
1382
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1383
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1384
 
        from bzrlib._walkdirs_win32 import Win32ReadDir
1385
 
        self._save_platform_info()
1386
 
        osutils._selected_dir_reader = Win32ReadDir()
1387
 
        name0u = u'0file-\xb6'
1388
 
        name1u = u'1dir-\u062c\u0648'
1389
 
        name2u = u'2file-\u0633'
1390
 
        tree = [
1391
 
            name0u,
1392
 
            name1u + '/',
1393
 
            name1u + '/' + name0u,
1394
 
            name1u + '/' + name1u + '/',
1395
 
            name2u,
1396
 
            ]
1397
 
        self.build_tree(tree)
1398
 
        name0 = name0u.encode('utf8')
1399
 
        name1 = name1u.encode('utf8')
1400
 
        name2 = name2u.encode('utf8')
1401
 
 
1402
 
        # All of the abspaths should be in unicode, all of the relative paths
1403
 
        # should be in utf8
1404
 
        expected_dirblocks = [
1405
 
                (('', '.'),
1406
 
                 [(name0, name0, 'file', './' + name0u),
1407
 
                  (name1, name1, 'directory', './' + name1u),
1408
 
                  (name2, name2, 'file', './' + name2u),
1409
 
                 ]
1410
 
                ),
1411
 
                ((name1, './' + name1u),
1412
 
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
1413
 
                                                        + '/' + name0u),
1414
 
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
1415
 
                                                            + '/' + name1u),
1416
 
                 ]
1417
 
                ),
1418
 
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
1419
 
                 [
1420
 
                 ]
1421
 
                ),
1422
 
            ]
1423
 
        result = list(osutils._walkdirs_utf8(u'.'))
1424
 
        self._filter_out_stat(result)
1425
 
        self.assertEqual(expected_dirblocks, result)
1426
 
 
1427
 
    def assertStatIsCorrect(self, path, win32stat):
1428
 
        os_stat = os.stat(path)
1429
 
        self.assertEqual(os_stat.st_size, win32stat.st_size)
1430
 
        self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
1431
 
        self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
1432
 
        self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
1433
 
        self.assertEqual(os_stat.st_dev, win32stat.st_dev)
1434
 
        self.assertEqual(os_stat.st_ino, win32stat.st_ino)
1435
 
        self.assertEqual(os_stat.st_mode, win32stat.st_mode)
1436
 
 
1437
 
    def test__walkdirs_utf_win32_find_file_stat_file(self):
1438
 
        """make sure our Stat values are valid"""
1439
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1440
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1441
 
        from bzrlib._walkdirs_win32 import Win32ReadDir
1442
 
        name0u = u'0file-\xb6'
1443
 
        name0 = name0u.encode('utf8')
1444
 
        self.build_tree([name0u])
1445
 
        # I hate to sleep() here, but I'm trying to make the ctime different
1446
 
        # from the mtime
1447
 
        time.sleep(2)
1448
 
        f = open(name0u, 'ab')
 
762
        name0u = u'0file-\xb6'
 
763
        name1u = u'1dir-\u062c\u0648'
 
764
        name2u = u'2file-\u0633'
 
765
        tree = [
 
766
            name0u,
 
767
            name1u + '/',
 
768
            name1u + '/' + name0u,
 
769
            name1u + '/' + name1u + '/',
 
770
            name2u,
 
771
            ]
1449
772
        try:
1450
 
            f.write('just a small update')
1451
 
        finally:
1452
 
            f.close()
1453
 
 
1454
 
        result = Win32ReadDir().read_dir('', u'.')
1455
 
        entry = result[0]
1456
 
        self.assertEqual((name0, name0, 'file'), entry[:3])
1457
 
        self.assertEqual(u'./' + name0u, entry[4])
1458
 
        self.assertStatIsCorrect(entry[4], entry[3])
1459
 
        self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
1460
 
 
1461
 
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
1462
 
        """make sure our Stat values are valid"""
1463
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1464
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1465
 
        from bzrlib._walkdirs_win32 import Win32ReadDir
1466
 
        name0u = u'0dir-\u062c\u0648'
 
773
            self.build_tree(tree)
 
774
        except UnicodeError:
 
775
            raise TestSkipped('Could not represent Unicode chars'
 
776
                              ' in current encoding.')
1467
777
        name0 = name0u.encode('utf8')
1468
 
        self.build_tree([name0u + '/'])
 
778
        name1 = name1u.encode('utf8')
 
779
        name2 = name2u.encode('utf8')
1469
780
 
1470
 
        result = Win32ReadDir().read_dir('', u'.')
1471
 
        entry = result[0]
1472
 
        self.assertEqual((name0, name0, 'directory'), entry[:3])
1473
 
        self.assertEqual(u'./' + name0u, entry[4])
1474
 
        self.assertStatIsCorrect(entry[4], entry[3])
 
781
        # All of the abspaths should be in unicode, all of the relative paths
 
782
        # should be in utf8
 
783
        expected_dirblocks = [
 
784
                (('', '.'),
 
785
                 [(name0, name0, 'file', './' + name0u),
 
786
                  (name1, name1, 'directory', './' + name1u),
 
787
                  (name2, name2, 'file', './' + name2u),
 
788
                 ]
 
789
                ),
 
790
                ((name1, './' + name1u),
 
791
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
792
                                                        + '/' + name0u),
 
793
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
794
                                                            + '/' + name1u),
 
795
                 ]
 
796
                ),
 
797
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
798
                 [
 
799
                 ]
 
800
                ),
 
801
            ]
 
802
        result = list(osutils._walkdirs_unicode_to_utf8('.'))
 
803
        self._filter_out_stat(result)
 
804
        self.assertEqual(expected_dirblocks, result)
1475
805
 
1476
806
    def assertPathCompare(self, path_less, path_greater):
1477
807
        """check that path_less and path_greater compare correctly."""
1551
881
            sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
1552
882
 
1553
883
 
1554
 
class TestCopyTree(tests.TestCaseInTempDir):
1555
 
 
 
884
class TestCopyTree(TestCaseInTempDir):
 
885
    
1556
886
    def test_copy_basic_tree(self):
1557
887
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1558
888
        osutils.copy_tree('source', 'target')
1567
897
        self.assertEqual(['c'], os.listdir('target/b'))
1568
898
 
1569
899
    def test_copy_tree_symlinks(self):
1570
 
        self.requireFeature(tests.SymlinkFeature)
 
900
        if not osutils.has_symlinks():
 
901
            return
1571
902
        self.build_tree(['source/'])
1572
903
        os.symlink('a/generic/path', 'source/lnk')
1573
904
        osutils.copy_tree('source', 'target')
1603
934
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1604
935
 
1605
936
 
1606
 
class TestSetUnsetEnv(tests.TestCase):
 
937
#class TestTerminalEncoding has been moved to test_osutils_encodings.py
 
938
# [bialix] 2006/12/26
 
939
 
 
940
 
 
941
class TestSetUnsetEnv(TestCase):
1607
942
    """Test updating the environment"""
1608
943
 
1609
944
    def setUp(self):
1615
950
        def cleanup():
1616
951
            if 'BZR_TEST_ENV_VAR' in os.environ:
1617
952
                del os.environ['BZR_TEST_ENV_VAR']
 
953
 
1618
954
        self.addCleanup(cleanup)
1619
955
 
1620
956
    def test_set(self):
1632
968
 
1633
969
    def test_unicode(self):
1634
970
        """Environment can only contain plain strings
1635
 
 
 
971
        
1636
972
        So Unicode strings must be encoded.
1637
973
        """
1638
 
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
1639
 
        if uni_val is None:
1640
 
            raise tests.TestSkipped(
1641
 
                'Cannot find a unicode character that works in encoding %s'
1642
 
                % (osutils.get_user_encoding(),))
 
974
        # Try a few different characters, to see if we can get
 
975
        # one that will be valid in the user_encoding
 
976
        possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
 
977
        for uni_val in possible_vals:
 
978
            try:
 
979
                env_val = uni_val.encode(bzrlib.user_encoding)
 
980
            except UnicodeEncodeError:
 
981
                # Try a different character
 
982
                pass
 
983
            else:
 
984
                break
 
985
        else:
 
986
            raise TestSkipped('Cannot find a unicode character that works in'
 
987
                              ' encoding %s' % (bzrlib.user_encoding,))
1643
988
 
1644
989
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
1645
990
        self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
1653
998
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
1654
999
 
1655
1000
 
1656
 
class TestSizeShaFile(tests.TestCaseInTempDir):
1657
 
 
1658
 
    def test_sha_empty(self):
1659
 
        self.build_tree_contents([('foo', '')])
1660
 
        expected_sha = osutils.sha_string('')
1661
 
        f = open('foo')
1662
 
        self.addCleanup(f.close)
1663
 
        size, sha = osutils.size_sha_file(f)
1664
 
        self.assertEqual(0, size)
1665
 
        self.assertEqual(expected_sha, sha)
1666
 
 
1667
 
    def test_sha_mixed_endings(self):
1668
 
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
1669
 
        self.build_tree_contents([('foo', text)])
1670
 
        expected_sha = osutils.sha_string(text)
1671
 
        f = open('foo', 'rb')
1672
 
        self.addCleanup(f.close)
1673
 
        size, sha = osutils.size_sha_file(f)
1674
 
        self.assertEqual(38, size)
1675
 
        self.assertEqual(expected_sha, sha)
1676
 
 
1677
 
 
1678
 
class TestShaFileByName(tests.TestCaseInTempDir):
1679
 
 
1680
 
    def test_sha_empty(self):
1681
 
        self.build_tree_contents([('foo', '')])
1682
 
        expected_sha = osutils.sha_string('')
1683
 
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1684
 
 
1685
 
    def test_sha_mixed_endings(self):
1686
 
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
1687
 
        self.build_tree_contents([('foo', text)])
1688
 
        expected_sha = osutils.sha_string(text)
1689
 
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1690
 
 
1691
 
 
1692
 
class TestResourceLoading(tests.TestCaseInTempDir):
1693
 
 
1694
 
    def test_resource_string(self):
1695
 
        # test resource in bzrlib
1696
 
        text = osutils.resource_string('bzrlib', 'debug.py')
1697
 
        self.assertContainsRe(text, "debug_flags = set()")
1698
 
        # test resource under bzrlib
1699
 
        text = osutils.resource_string('bzrlib.ui', 'text.py')
1700
 
        self.assertContainsRe(text, "class TextUIFactory")
1701
 
        # test unsupported package
1702
 
        self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
1703
 
            'yyy.xx')
1704
 
        # test unknown resource
1705
 
        self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
1706
 
 
1707
 
 
1708
 
class TestReCompile(tests.TestCase):
1709
 
 
1710
 
    def _deprecated_re_compile_checked(self, *args, **kwargs):
1711
 
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1712
 
            osutils.re_compile_checked, *args, **kwargs)
1713
 
 
1714
 
    def test_re_compile_checked(self):
1715
 
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1716
 
        self.assertTrue(r.match('aaaa'))
1717
 
        self.assertTrue(r.match('aAaA'))
1718
 
 
1719
 
    def test_re_compile_checked_error(self):
1720
 
        # like https://bugs.launchpad.net/bzr/+bug/251352
1721
 
 
1722
 
        # Due to possible test isolation error, re.compile is not lazy at
1723
 
        # this point. We re-install lazy compile.
1724
 
        lazy_regex.install_lazy_compile()
1725
 
        err = self.assertRaises(
1726
 
            errors.BzrCommandError,
1727
 
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1728
 
        self.assertEqual(
1729
 
            'Invalid regular expression in test case: '
1730
 
            '"*" nothing to repeat',
1731
 
            str(err))
1732
 
 
1733
 
 
1734
 
class TestDirReader(tests.TestCaseInTempDir):
1735
 
 
1736
 
    # Set by load_tests
1737
 
    _dir_reader_class = None
1738
 
    _native_to_unicode = None
1739
 
 
1740
 
    def setUp(self):
1741
 
        tests.TestCaseInTempDir.setUp(self)
1742
 
        self.overrideAttr(osutils,
1743
 
                          '_selected_dir_reader', self._dir_reader_class())
1744
 
 
1745
 
    def _get_ascii_tree(self):
1746
 
        tree = [
1747
 
            '0file',
1748
 
            '1dir/',
1749
 
            '1dir/0file',
1750
 
            '1dir/1dir/',
1751
 
            '2file'
1752
 
            ]
1753
 
        expected_dirblocks = [
1754
 
                (('', '.'),
1755
 
                 [('0file', '0file', 'file'),
1756
 
                  ('1dir', '1dir', 'directory'),
1757
 
                  ('2file', '2file', 'file'),
1758
 
                 ]
1759
 
                ),
1760
 
                (('1dir', './1dir'),
1761
 
                 [('1dir/0file', '0file', 'file'),
1762
 
                  ('1dir/1dir', '1dir', 'directory'),
1763
 
                 ]
1764
 
                ),
1765
 
                (('1dir/1dir', './1dir/1dir'),
1766
 
                 [
1767
 
                 ]
1768
 
                ),
1769
 
            ]
1770
 
        return tree, expected_dirblocks
1771
 
 
1772
 
    def test_walk_cur_dir(self):
1773
 
        tree, expected_dirblocks = self._get_ascii_tree()
1774
 
        self.build_tree(tree)
1775
 
        result = list(osutils._walkdirs_utf8('.'))
1776
 
        # Filter out stat and abspath
1777
 
        self.assertEqual(expected_dirblocks,
1778
 
                         [(dirinfo, [line[0:3] for line in block])
1779
 
                          for dirinfo, block in result])
1780
 
 
1781
 
    def test_walk_sub_dir(self):
1782
 
        tree, expected_dirblocks = self._get_ascii_tree()
1783
 
        self.build_tree(tree)
1784
 
        # you can search a subdir only, with a supplied prefix.
1785
 
        result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
1786
 
        # Filter out stat and abspath
1787
 
        self.assertEqual(expected_dirblocks[1:],
1788
 
                         [(dirinfo, [line[0:3] for line in block])
1789
 
                          for dirinfo, block in result])
1790
 
 
1791
 
    def _get_unicode_tree(self):
1792
 
        name0u = u'0file-\xb6'
1793
 
        name1u = u'1dir-\u062c\u0648'
1794
 
        name2u = u'2file-\u0633'
1795
 
        tree = [
1796
 
            name0u,
1797
 
            name1u + '/',
1798
 
            name1u + '/' + name0u,
1799
 
            name1u + '/' + name1u + '/',
1800
 
            name2u,
1801
 
            ]
1802
 
        name0 = name0u.encode('UTF-8')
1803
 
        name1 = name1u.encode('UTF-8')
1804
 
        name2 = name2u.encode('UTF-8')
1805
 
        expected_dirblocks = [
1806
 
                (('', '.'),
1807
 
                 [(name0, name0, 'file', './' + name0u),
1808
 
                  (name1, name1, 'directory', './' + name1u),
1809
 
                  (name2, name2, 'file', './' + name2u),
1810
 
                 ]
1811
 
                ),
1812
 
                ((name1, './' + name1u),
1813
 
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
1814
 
                                                        + '/' + name0u),
1815
 
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
1816
 
                                                            + '/' + name1u),
1817
 
                 ]
1818
 
                ),
1819
 
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
1820
 
                 [
1821
 
                 ]
1822
 
                ),
1823
 
            ]
1824
 
        return tree, expected_dirblocks
1825
 
 
1826
 
    def _filter_out(self, raw_dirblocks):
1827
 
        """Filter out a walkdirs_utf8 result.
1828
 
 
1829
 
        stat field is removed, all native paths are converted to unicode
1830
 
        """
1831
 
        filtered_dirblocks = []
1832
 
        for dirinfo, block in raw_dirblocks:
1833
 
            dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
1834
 
            details = []
1835
 
            for line in block:
1836
 
                details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
1837
 
            filtered_dirblocks.append((dirinfo, details))
1838
 
        return filtered_dirblocks
1839
 
 
1840
 
    def test_walk_unicode_tree(self):
1841
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1842
 
        tree, expected_dirblocks = self._get_unicode_tree()
1843
 
        self.build_tree(tree)
1844
 
        result = list(osutils._walkdirs_utf8('.'))
1845
 
        self.assertEqual(expected_dirblocks, self._filter_out(result))
1846
 
 
1847
 
    def test_symlink(self):
1848
 
        self.requireFeature(tests.SymlinkFeature)
1849
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1850
 
        target = u'target\N{Euro Sign}'
1851
 
        link_name = u'l\N{Euro Sign}nk'
1852
 
        os.symlink(target, link_name)
1853
 
        target_utf8 = target.encode('UTF-8')
1854
 
        link_name_utf8 = link_name.encode('UTF-8')
1855
 
        expected_dirblocks = [
1856
 
                (('', '.'),
1857
 
                 [(link_name_utf8, link_name_utf8,
1858
 
                   'symlink', './' + link_name),],
1859
 
                 )]
1860
 
        result = list(osutils._walkdirs_utf8('.'))
1861
 
        self.assertEqual(expected_dirblocks, self._filter_out(result))
1862
 
 
1863
 
 
1864
 
class TestReadLink(tests.TestCaseInTempDir):
1865
 
    """Exposes os.readlink() problems and the osutils solution.
1866
 
 
1867
 
    The only guarantee offered by os.readlink(), starting with 2.6, is that a
1868
 
    unicode string will be returned if a unicode string is passed.
1869
 
 
1870
 
    But prior python versions failed to properly encode the passed unicode
1871
 
    string.
1872
 
    """
1873
 
    _test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
1874
 
 
1875
 
    def setUp(self):
1876
 
        super(tests.TestCaseInTempDir, self).setUp()
1877
 
        self.link = u'l\N{Euro Sign}ink'
1878
 
        self.target = u'targe\N{Euro Sign}t'
1879
 
        os.symlink(self.target, self.link)
1880
 
 
1881
 
    def test_os_readlink_link_encoding(self):
1882
 
        if sys.version_info < (2, 6):
1883
 
            self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
1884
 
        else:
1885
 
            self.assertEquals(self.target,  os.readlink(self.link))
1886
 
 
1887
 
    def test_os_readlink_link_decoding(self):
1888
 
        self.assertEquals(self.target.encode(osutils._fs_enc),
1889
 
                          os.readlink(self.link.encode(osutils._fs_enc)))
1890
 
 
1891
 
 
1892
 
class TestConcurrency(tests.TestCase):
1893
 
 
1894
 
    def setUp(self):
1895
 
        super(TestConcurrency, self).setUp()
1896
 
        self.overrideAttr(osutils, '_cached_local_concurrency')
1897
 
 
1898
 
    def test_local_concurrency(self):
1899
 
        concurrency = osutils.local_concurrency()
1900
 
        self.assertIsInstance(concurrency, int)
1901
 
 
1902
 
    def test_local_concurrency_environment_variable(self):
1903
 
        os.environ['BZR_CONCURRENCY'] = '2'
1904
 
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1905
 
        os.environ['BZR_CONCURRENCY'] = '3'
1906
 
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1907
 
        os.environ['BZR_CONCURRENCY'] = 'foo'
1908
 
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1909
 
 
1910
 
    def test_option_concurrency(self):
1911
 
        os.environ['BZR_CONCURRENCY'] = '1'
1912
 
        self.run_bzr('rocks --concurrency 42')
1913
 
        # Command line overrides envrionment variable
1914
 
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1915
 
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
1916
 
 
1917
 
 
1918
 
class TestFailedToLoadExtension(tests.TestCase):
1919
 
 
1920
 
    def _try_loading(self):
1921
 
        try:
1922
 
            import bzrlib._fictional_extension_py
1923
 
        except ImportError, e:
1924
 
            osutils.failed_to_load_extension(e)
1925
 
            return True
1926
 
 
1927
 
    def setUp(self):
1928
 
        super(TestFailedToLoadExtension, self).setUp()
1929
 
        self.overrideAttr(osutils, '_extension_load_failures', [])
1930
 
 
1931
 
    def test_failure_to_load(self):
1932
 
        self._try_loading()
1933
 
        self.assertLength(1, osutils._extension_load_failures)
1934
 
        self.assertEquals(osutils._extension_load_failures[0],
1935
 
            "No module named _fictional_extension_py")
1936
 
 
1937
 
    def test_report_extension_load_failures_no_warning(self):
1938
 
        self.assertTrue(self._try_loading())
1939
 
        warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
1940
 
        # it used to give a Python warning; it no longer does
1941
 
        self.assertLength(0, warnings)
1942
 
 
1943
 
    def test_report_extension_load_failures_message(self):
1944
 
        log = StringIO()
1945
 
        trace.push_log_file(log)
1946
 
        self.assertTrue(self._try_loading())
1947
 
        osutils.report_extension_load_failures()
1948
 
        self.assertContainsRe(
1949
 
            log.getvalue(),
1950
 
            r"bzr: warning: some compiled extensions could not be loaded; "
1951
 
            "see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
1952
 
            )
1953
 
 
1954
 
 
1955
 
class TestTerminalWidth(tests.TestCase):
1956
 
 
1957
 
    def setUp(self):
1958
 
        tests.TestCase.setUp(self)
1959
 
        self._orig_terminal_size_state = osutils._terminal_size_state
1960
 
        self._orig_first_terminal_size = osutils._first_terminal_size
1961
 
        self.addCleanup(self.restore_osutils_globals)
1962
 
        osutils._terminal_size_state = 'no_data'
1963
 
        osutils._first_terminal_size = None
1964
 
 
1965
 
    def restore_osutils_globals(self):
1966
 
        osutils._terminal_size_state = self._orig_terminal_size_state
1967
 
        osutils._first_terminal_size = self._orig_first_terminal_size
1968
 
 
1969
 
    def replace_stdout(self, new):
1970
 
        self.overrideAttr(sys, 'stdout', new)
1971
 
 
1972
 
    def replace__terminal_size(self, new):
1973
 
        self.overrideAttr(osutils, '_terminal_size', new)
1974
 
 
1975
 
    def set_fake_tty(self):
1976
 
 
1977
 
        class I_am_a_tty(object):
1978
 
            def isatty(self):
1979
 
                return True
1980
 
 
1981
 
        self.replace_stdout(I_am_a_tty())
1982
 
 
1983
 
    def test_default_values(self):
1984
 
        self.assertEqual(80, osutils.default_terminal_width)
1985
 
 
1986
 
    def test_defaults_to_BZR_COLUMNS(self):
1987
 
        # BZR_COLUMNS is set by the test framework
1988
 
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
1989
 
        os.environ['BZR_COLUMNS'] = '12'
1990
 
        self.assertEqual(12, osutils.terminal_width())
1991
 
 
1992
 
    def test_falls_back_to_COLUMNS(self):
1993
 
        del os.environ['BZR_COLUMNS']
1994
 
        self.assertNotEqual('42', os.environ['COLUMNS'])
1995
 
        self.set_fake_tty()
1996
 
        os.environ['COLUMNS'] = '42'
1997
 
        self.assertEqual(42, osutils.terminal_width())
1998
 
 
1999
 
    def test_tty_default_without_columns(self):
2000
 
        del os.environ['BZR_COLUMNS']
2001
 
        del os.environ['COLUMNS']
2002
 
 
2003
 
        def terminal_size(w, h):
2004
 
            return 42, 42
2005
 
 
2006
 
        self.set_fake_tty()
2007
 
        # We need to override the osutils definition as it depends on the
2008
 
        # running environment that we can't control (PQM running without a
2009
 
        # controlling terminal is one example).
2010
 
        self.replace__terminal_size(terminal_size)
2011
 
        self.assertEqual(42, osutils.terminal_width())
2012
 
 
2013
 
    def test_non_tty_default_without_columns(self):
2014
 
        del os.environ['BZR_COLUMNS']
2015
 
        del os.environ['COLUMNS']
2016
 
        self.replace_stdout(None)
2017
 
        self.assertEqual(None, osutils.terminal_width())
2018
 
 
2019
 
    def test_no_TIOCGWINSZ(self):
2020
 
        self.requireFeature(term_ios_feature)
2021
 
        termios = term_ios_feature.module
2022
 
        # bug 63539 is about a termios without TIOCGWINSZ attribute
2023
 
        try:
2024
 
            orig = termios.TIOCGWINSZ
2025
 
        except AttributeError:
2026
 
            # We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
2027
 
            pass
2028
 
        else:
2029
 
            self.overrideAttr(termios, 'TIOCGWINSZ')
2030
 
            del termios.TIOCGWINSZ
2031
 
        del os.environ['BZR_COLUMNS']
2032
 
        del os.environ['COLUMNS']
2033
 
        # Whatever the result is, if we don't raise an exception, it's ok.
2034
 
        osutils.terminal_width()
2035
 
 
2036
 
class TestCreationOps(tests.TestCaseInTempDir):
2037
 
    _test_needs_features = [features.chown_feature]
2038
 
 
2039
 
    def setUp(self):
2040
 
        tests.TestCaseInTempDir.setUp(self)
2041
 
        self.overrideAttr(os, 'chown', self._dummy_chown)
2042
 
 
2043
 
        # params set by call to _dummy_chown
2044
 
        self.path = self.uid = self.gid = None
2045
 
 
2046
 
    def _dummy_chown(self, path, uid, gid):
2047
 
        self.path, self.uid, self.gid = path, uid, gid
2048
 
 
2049
 
    def test_copy_ownership_from_path(self):
2050
 
        """copy_ownership_from_path test with specified src."""
2051
 
        ownsrc = '/'
2052
 
        f = open('test_file', 'wt')
2053
 
        osutils.copy_ownership_from_path('test_file', ownsrc)
2054
 
 
2055
 
        s = os.stat(ownsrc)
2056
 
        self.assertEquals(self.path, 'test_file')
2057
 
        self.assertEquals(self.uid, s.st_uid)
2058
 
        self.assertEquals(self.gid, s.st_gid)
2059
 
 
2060
 
    def test_copy_ownership_nonesrc(self):
2061
 
        """copy_ownership_from_path test with src=None."""
2062
 
        f = open('test_file', 'wt')
2063
 
        # should use parent dir for permissions
2064
 
        osutils.copy_ownership_from_path('test_file')
2065
 
 
2066
 
        s = os.stat('..')
2067
 
        self.assertEquals(self.path, 'test_file')
2068
 
        self.assertEquals(self.uid, s.st_uid)
2069
 
        self.assertEquals(self.gid, s.st_gid)
2070
 
 
2071
 
class TestGetuserUnicode(tests.TestCase):
2072
 
 
2073
 
    def test_ascii_user(self):
2074
 
        osutils.set_or_unset_env('LOGNAME', 'jrandom')
2075
 
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
2076
 
 
2077
 
    def test_unicode_user(self):
2078
 
        ue = osutils.get_user_encoding()
2079
 
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
2080
 
        if uni_val is None:
2081
 
            raise tests.TestSkipped(
2082
 
                'Cannot find a unicode character that works in encoding %s'
2083
 
                % (osutils.get_user_encoding(),))
2084
 
        uni_username = u'jrandom' + uni_val
2085
 
        encoded_username = uni_username.encode(ue)
2086
 
        osutils.set_or_unset_env('LOGNAME', encoded_username)
2087
 
        self.assertEqual(uni_username, osutils.getuser_unicode())
 
1001
class TestLocalTimeOffset(TestCase):
 
1002
 
 
1003
    def test_local_time_offset(self):
 
1004
        """Test that local_time_offset() returns a sane value."""
 
1005
        offset = osutils.local_time_offset()
 
1006
        self.assertTrue(isinstance(offset, int))
 
1007
        # Test that the offset is no more than a eighteen hours in
 
1008
        # either direction.
 
1009
        # Time zone handling is system specific, so it is difficult to
 
1010
        # do more specific tests, but a value outside of this range is
 
1011
        # probably wrong.
 
1012
        eighteen_hours = 18 * 3600
 
1013
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
1014
 
 
1015
    def test_local_time_offset_with_timestamp(self):
 
1016
        """Test that local_time_offset() works with a timestamp."""
 
1017
        offset = osutils.local_time_offset(1000000000.1234567)
 
1018
        self.assertTrue(isinstance(offset, int))
 
1019
        eighteen_hours = 18 * 3600
 
1020
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)