~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: John Arbash Meinel
  • Date: 2007-01-25 15:54:29 UTC
  • mto: This revision was merged to the branch mainline in revision 2245.
  • Revision ID: john@arbash-meinel.com-20070125155429-x53892xqx4r17l8h
Clean up the documentation and imports for decorators (per Martin's suggestions)

Show diffs side-by-side

added added

removed removed

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