/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: Colin D Bennett
  • Date: 2009-02-12 16:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4008.
  • Revision ID: colin@gibibit.com-20090212165739-02xv63odccfmxomw
Generate PDF version of the User Guide.

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, 2007, 2008, 2009 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
19
from cStringIO import StringIO
20
20
import errno
21
21
import os
22
 
import re
23
22
import socket
24
23
import stat
25
24
import sys
29
28
    errors,
30
29
    osutils,
31
30
    tests,
32
 
    trace,
33
31
    win32utils,
34
32
    )
 
33
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
 
34
from bzrlib.osutils import (
 
35
        is_inside_any,
 
36
        is_inside_or_parent_of_any,
 
37
        pathjoin,
 
38
        pumpfile,
 
39
        pump_string_file,
 
40
        canonical_relpath,
 
41
        )
35
42
from bzrlib.tests import (
36
 
    features,
37
 
    file_utils,
38
 
    test__walkdirs_win32,
 
43
        adapt_tests,
 
44
        Feature,
 
45
        probe_unicode_in_user_encoding,
 
46
        split_suite_by_re,
 
47
        StringIOWrapper,
 
48
        SymlinkFeature,
 
49
        CaseInsCasePresFilenameFeature,
 
50
        TestCase,
 
51
        TestCaseInTempDir,
 
52
        TestScenarioApplier,
 
53
        TestSkipped,
 
54
        )
 
55
from bzrlib.tests.file_utils import (
 
56
    FakeReadFile,
39
57
    )
40
 
 
41
 
 
42
 
class _UTF8DirReaderFeature(tests.Feature):
 
58
from bzrlib.tests.test__walkdirs_win32 import Win32ReadDirFeature
 
59
 
 
60
 
 
61
class _UTF8DirReaderFeature(Feature):
43
62
 
44
63
    def _probe(self):
45
64
        try:
54
73
 
55
74
UTF8DirReaderFeature = _UTF8DirReaderFeature()
56
75
 
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):
 
76
 
 
77
class TestOSUtils(TestCaseInTempDir):
108
78
 
109
79
    def test_contains_whitespace(self):
110
80
        self.failUnless(osutils.contains_whitespace(u' '))
120
90
        self.failIf(osutils.contains_whitespace(u'hellothere'))
121
91
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
122
92
 
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)
136
 
 
137
93
    def test_fancy_rename(self):
138
94
        # This should work everywhere
139
 
        self.create_file('a', 'something in a\n')
140
 
        self._fancy_rename('a', 'b')
 
95
        def rename(a, b):
 
96
            osutils.fancy_rename(a, b,
 
97
                    rename_func=os.rename,
 
98
                    unlink_func=os.unlink)
 
99
 
 
100
        open('a', 'wb').write('something in a\n')
 
101
        rename('a', 'b')
141
102
        self.failIfExists('a')
142
103
        self.failUnlessExists('b')
143
104
        self.check_file_contents('b', 'something in a\n')
144
105
 
145
 
        self.create_file('a', 'new something in a\n')
146
 
        self._fancy_rename('b', 'a')
 
106
        open('a', 'wb').write('new something in a\n')
 
107
        rename('b', 'a')
147
108
 
148
109
        self.check_file_contents('a', 'something in a\n')
149
110
 
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
111
    def test_rename(self):
163
112
        # Rename should be semi-atomic on all platforms
164
 
        self.create_file('a', 'something in a\n')
 
113
        open('a', 'wb').write('something in a\n')
165
114
        osutils.rename('a', 'b')
166
115
        self.failIfExists('a')
167
116
        self.failUnlessExists('b')
168
117
        self.check_file_contents('b', 'something in a\n')
169
118
 
170
 
        self.create_file('a', 'new something in a\n')
 
119
        open('a', 'wb').write('new something in a\n')
171
120
        osutils.rename('b', 'a')
172
121
 
173
122
        self.check_file_contents('a', 'something in a\n')
184
133
        shape = sorted(os.listdir('.'))
185
134
        self.assertEquals(['A', 'B'], shape)
186
135
 
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
136
    def test_01_rand_chars_empty(self):
198
137
        result = osutils.rand_chars(0)
199
138
        self.assertEqual(result, '')
204
143
        self.assertEqual(type(result), str)
205
144
        self.assertContainsRe(result, r'^[a-z0-9]{100}$')
206
145
 
207
 
 
208
 
class TestIsInside(tests.TestCase):
209
 
 
210
146
    def test_is_inside(self):
211
147
        is_inside = osutils.is_inside
212
148
        self.assertTrue(is_inside('src', 'src/foo.c'))
217
153
        self.assertTrue(is_inside('', 'foo.c'))
218
154
 
219
155
    def test_is_inside_any(self):
220
 
        SRC_FOO_C = osutils.pathjoin('src', 'foo.c')
 
156
        SRC_FOO_C = pathjoin('src', 'foo.c')
221
157
        for dirs, fn in [(['src', 'doc'], SRC_FOO_C),
222
158
                         (['src'], SRC_FOO_C),
223
159
                         (['src'], 'src'),
224
160
                         ]:
225
 
            self.assert_(osutils.is_inside_any(dirs, fn))
 
161
            self.assert_(is_inside_any(dirs, fn))
226
162
        for dirs, fn in [(['src'], 'srccontrol'),
227
163
                         (['src'], 'srccontrol/foo')]:
228
 
            self.assertFalse(osutils.is_inside_any(dirs, fn))
 
164
            self.assertFalse(is_inside_any(dirs, fn))
229
165
 
230
166
    def test_is_inside_or_parent_of_any(self):
231
167
        for dirs, fn in [(['src', 'doc'], 'src/foo.c'),
234
170
                         (['src/bar.c', 'bla/foo.c'], 'src'),
235
171
                         (['src'], 'src'),
236
172
                         ]:
237
 
            self.assert_(osutils.is_inside_or_parent_of_any(dirs, fn))
238
 
 
 
173
            self.assert_(is_inside_or_parent_of_any(dirs, fn))
 
174
            
239
175
        for dirs, fn in [(['src'], 'srccontrol'),
240
176
                         (['srccontrol/foo.c'], 'src'),
241
177
                         (['src'], 'srccontrol/foo')]:
242
 
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
243
 
 
244
 
 
245
 
class TestRmTree(tests.TestCaseInTempDir):
 
178
            self.assertFalse(is_inside_or_parent_of_any(dirs, fn))
246
179
 
247
180
    def test_rmtree(self):
248
181
        # Check to remove tree with read-only files/dirs
262
195
        self.failIfExists('dir/file')
263
196
        self.failIfExists('dir')
264
197
 
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
198
    def test_file_kind(self):
281
199
        self.build_tree(['file', 'dir/'])
282
200
        self.assertEquals('file', osutils.file_kind('file'))
284
202
        if osutils.has_symlinks():
285
203
            os.symlink('symlink', 'symlink')
286
204
            self.assertEquals('symlink', osutils.file_kind('symlink'))
287
 
 
 
205
        
288
206
        # TODO: jam 20060529 Test a block device
289
207
        try:
290
208
            os.lstat('/dev/null')
312
230
                os.remove('socket')
313
231
 
314
232
    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):
 
233
        self.assertEqual(osutils.kind_marker('file'), '')
 
234
        self.assertEqual(osutils.kind_marker('directory'), '/')
 
235
        self.assertEqual(osutils.kind_marker('symlink'), '@')
 
236
        self.assertEqual(osutils.kind_marker('tree-reference'), '+')
326
237
 
327
238
    def test_get_umask(self):
328
239
        if sys.platform == 'win32':
331
242
            return
332
243
 
333
244
        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):
 
245
        try:
 
246
            os.umask(0222)
 
247
            self.assertEqual(0222, osutils.get_umask())
 
248
            os.umask(0022)
 
249
            self.assertEqual(0022, osutils.get_umask())
 
250
            os.umask(0002)
 
251
            self.assertEqual(0002, osutils.get_umask())
 
252
            os.umask(0027)
 
253
            self.assertEqual(0027, osutils.get_umask())
 
254
        finally:
 
255
            os.umask(orig_umask)
346
256
 
347
257
    def assertFormatedDelta(self, expected, seconds):
348
258
        """Assert osutils.format_delta formats as expected"""
390
300
        # Instead blackbox.test_locale should check for localized
391
301
        # dates once they do occur in output strings.
392
302
 
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
303
    def test_dereference_path(self):
424
 
        self.requireFeature(tests.SymlinkFeature)
 
304
        self.requireFeature(SymlinkFeature)
425
305
        cwd = osutils.realpath('.')
426
306
        os.mkdir('bar')
427
307
        bar_path = osutils.pathjoin(cwd, 'bar')
430
310
        self.assertEqual(bar_path, osutils.realpath('./bar'))
431
311
        os.symlink('bar', 'foo')
432
312
        self.assertEqual(bar_path, osutils.realpath('./foo'))
433
 
 
 
313
        
434
314
        # Does not dereference terminal symlinks
435
315
        foo_path = osutils.pathjoin(cwd, 'foo')
436
316
        self.assertEqual(foo_path, osutils.dereference_path('./foo'))
468
348
            osutils.make_readonly('dangling')
469
349
            osutils.make_writable('dangling')
470
350
 
 
351
    def test_kind_marker(self):
 
352
        self.assertEqual("", osutils.kind_marker("file"))
 
353
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
 
354
        self.assertEqual("@", osutils.kind_marker("symlink"))
 
355
        self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
 
356
 
471
357
    def test_host_os_dereferences_symlinks(self):
472
358
        osutils.host_os_dereferences_symlinks()
473
359
 
474
360
 
475
 
class TestCanonicalRelPath(tests.TestCaseInTempDir):
 
361
class TestCanonicalRelPath(TestCaseInTempDir):
476
362
 
477
 
    _test_needs_features = [tests.CaseInsCasePresFilenameFeature]
 
363
    _test_needs_features = [CaseInsCasePresFilenameFeature]
478
364
 
479
365
    def test_canonical_relpath_simple(self):
480
366
        f = file('MixedCaseName', 'w')
481
367
        f.close()
482
 
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
483
 
        self.failUnlessEqual('work/MixedCaseName', actual)
 
368
        self.failUnlessEqual(
 
369
            canonical_relpath(self.test_base_dir, 'mixedcasename'),
 
370
            'work/MixedCaseName')
484
371
 
485
372
    def test_canonical_relpath_missing_tail(self):
486
373
        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):
 
374
        self.failUnlessEqual(
 
375
            canonical_relpath(self.test_base_dir, 'mixedcaseparent/nochild'),
 
376
            'work/MixedCaseParent/nochild')
 
377
 
 
378
 
 
379
class TestPumpFile(TestCase):
536
380
    """Test pumpfile method."""
537
 
 
538
381
    def setUp(self):
539
 
        tests.TestCase.setUp(self)
540
382
        # create a test datablock
541
383
        self.block_size = 512
542
384
        pattern = '0123456789ABCDEF'
549
391
        # make sure test data is larger than max read size
550
392
        self.assertTrue(self.test_data_len > self.block_size)
551
393
 
552
 
        from_file = file_utils.FakeReadFile(self.test_data)
 
394
        from_file = FakeReadFile(self.test_data)
553
395
        to_file = StringIO()
554
396
 
555
397
        # read (max / 2) bytes and verify read size wasn't affected
556
398
        num_bytes_to_read = self.block_size / 2
557
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
399
        pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
558
400
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
559
401
        self.assertEqual(from_file.get_read_count(), 1)
560
402
 
561
403
        # read (max) bytes and verify read size wasn't affected
562
404
        num_bytes_to_read = self.block_size
563
405
        from_file.reset_read_count()
564
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
406
        pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
565
407
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
566
408
        self.assertEqual(from_file.get_read_count(), 1)
567
409
 
568
410
        # read (max + 1) bytes and verify read size was limited
569
411
        num_bytes_to_read = self.block_size + 1
570
412
        from_file.reset_read_count()
571
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
413
        pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
572
414
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
573
415
        self.assertEqual(from_file.get_read_count(), 2)
574
416
 
575
417
        # finish reading the rest of the data
576
418
        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)
 
419
        pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
578
420
 
579
421
        # report error if the data wasn't equal (we only report the size due
580
422
        # to the length of the data)
590
432
        self.assertTrue(self.test_data_len > self.block_size)
591
433
 
592
434
        # retrieve data in blocks
593
 
        from_file = file_utils.FakeReadFile(self.test_data)
 
435
        from_file = FakeReadFile(self.test_data)
594
436
        to_file = StringIO()
595
 
        osutils.pumpfile(from_file, to_file, self.test_data_len,
596
 
                         self.block_size)
 
437
        pumpfile(from_file, to_file, self.test_data_len, self.block_size)
597
438
 
598
439
        # verify read size was equal to the maximum read size
599
440
        self.assertTrue(from_file.get_max_read_size() > 0)
614
455
        self.assertTrue(self.test_data_len > self.block_size)
615
456
 
616
457
        # retrieve data to EOF
617
 
        from_file = file_utils.FakeReadFile(self.test_data)
 
458
        from_file = FakeReadFile(self.test_data)
618
459
        to_file = StringIO()
619
 
        osutils.pumpfile(from_file, to_file, -1, self.block_size)
 
460
        pumpfile(from_file, to_file, -1, self.block_size)
620
461
 
621
462
        # verify read size was equal to the maximum read size
622
463
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
634
475
        test verifies that any existing usages of pumpfile will not be broken
635
476
        with this new version."""
636
477
        # retrieve data using default (old) pumpfile method
637
 
        from_file = file_utils.FakeReadFile(self.test_data)
 
478
        from_file = FakeReadFile(self.test_data)
638
479
        to_file = StringIO()
639
 
        osutils.pumpfile(from_file, to_file)
 
480
        pumpfile(from_file, to_file)
640
481
 
641
482
        # report error if the data wasn't equal (we only report the size due
642
483
        # to the length of the data)
651
492
            activity.append((length, direction))
652
493
        from_file = StringIO(self.test_data)
653
494
        to_file = StringIO()
654
 
        osutils.pumpfile(from_file, to_file, buff_size=500,
655
 
                         report_activity=log_activity, direction='read')
 
495
        pumpfile(from_file, to_file, buff_size=500,
 
496
                 report_activity=log_activity, direction='read')
656
497
        self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
657
498
                          (36, 'read')], activity)
658
499
 
659
500
        from_file = StringIO(self.test_data)
660
501
        to_file = StringIO()
661
502
        del activity[:]
662
 
        osutils.pumpfile(from_file, to_file, buff_size=500,
663
 
                         report_activity=log_activity, direction='write')
 
503
        pumpfile(from_file, to_file, buff_size=500,
 
504
                 report_activity=log_activity, direction='write')
664
505
        self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
665
506
                          (36, 'write')], activity)
666
507
 
668
509
        from_file = StringIO(self.test_data)
669
510
        to_file = StringIO()
670
511
        del activity[:]
671
 
        osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
672
 
                         report_activity=log_activity, direction='read')
 
512
        pumpfile(from_file, to_file, buff_size=500, read_length=1028,
 
513
                 report_activity=log_activity, direction='read')
673
514
        self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
674
515
 
675
516
 
676
517
 
677
 
class TestPumpStringFile(tests.TestCase):
 
518
class TestPumpStringFile(TestCase):
678
519
 
679
520
    def test_empty(self):
680
521
        output = StringIO()
681
 
        osutils.pump_string_file("", output)
 
522
        pump_string_file("", output)
682
523
        self.assertEqual("", output.getvalue())
683
524
 
684
525
    def test_more_than_segment_size(self):
685
526
        output = StringIO()
686
 
        osutils.pump_string_file("123456789", output, 2)
 
527
        pump_string_file("123456789", output, 2)
687
528
        self.assertEqual("123456789", output.getvalue())
688
529
 
689
530
    def test_segment_size(self):
690
531
        output = StringIO()
691
 
        osutils.pump_string_file("12", output, 2)
 
532
        pump_string_file("12", output, 2)
692
533
        self.assertEqual("12", output.getvalue())
693
534
 
694
535
    def test_segment_size_multiple(self):
695
536
        output = StringIO()
696
 
        osutils.pump_string_file("1234", output, 2)
 
537
        pump_string_file("1234", output, 2)
697
538
        self.assertEqual("1234", output.getvalue())
698
539
 
699
540
 
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):
 
541
class TestSafeUnicode(TestCase):
720
542
 
721
543
    def test_from_ascii_string(self):
722
544
        self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
731
553
        self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
732
554
 
733
555
    def test_bad_utf8_string(self):
734
 
        self.assertRaises(errors.BzrBadParameterNotUnicode,
 
556
        self.assertRaises(BzrBadParameterNotUnicode,
735
557
                          osutils.safe_unicode,
736
558
                          '\xbb\xbb')
737
559
 
738
560
 
739
 
class TestSafeUtf8(tests.TestCase):
 
561
class TestSafeUtf8(TestCase):
740
562
 
741
563
    def test_from_ascii_string(self):
742
564
        f = 'foobar'
752
574
        self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
753
575
 
754
576
    def test_bad_utf8_string(self):
755
 
        self.assertRaises(errors.BzrBadParameterNotUnicode,
 
577
        self.assertRaises(BzrBadParameterNotUnicode,
756
578
                          osutils.safe_utf8, '\xbb\xbb')
757
579
 
758
580
 
759
 
class TestSafeRevisionId(tests.TestCase):
 
581
class TestSafeRevisionId(TestCase):
760
582
 
761
583
    def test_from_ascii_string(self):
762
584
        # this shouldn't give a warning because it's getting an ascii string
784
606
        self.assertEqual(None, osutils.safe_revision_id(None))
785
607
 
786
608
 
787
 
class TestSafeFileId(tests.TestCase):
 
609
class TestSafeFileId(TestCase):
788
610
 
789
611
    def test_from_ascii_string(self):
790
612
        self.assertEqual('foobar', osutils.safe_file_id('foobar'))
810
632
        self.assertEqual(None, osutils.safe_file_id(None))
811
633
 
812
634
 
813
 
class TestWin32Funcs(tests.TestCase):
814
 
    """Test that _win32 versions of os utilities return appropriate paths."""
 
635
class TestWin32Funcs(TestCase):
 
636
    """Test that the _win32 versions of os utilities return appropriate paths."""
815
637
 
816
638
    def test_abspath(self):
817
639
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
824
646
        self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
825
647
 
826
648
    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'))
 
649
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path', 'to', 'foo'))
 
650
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path\\to', 'C:\\foo'))
 
651
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path/to', 'C:/foo'))
 
652
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path/to/', 'foo'))
 
653
        self.assertEqual('/foo', osutils._win32_pathjoin('C:/path/to/', '/foo'))
 
654
        self.assertEqual('/foo', osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
839
655
 
840
656
    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'))
 
657
        self.assertEqual('path/to/foo', osutils._win32_normpath(r'path\\from\..\to\.\foo'))
 
658
        self.assertEqual('path/to/foo', osutils._win32_normpath('path//from/../to/./foo'))
845
659
 
846
660
    def test_getcwd(self):
847
661
        cwd = osutils._win32_getcwd()
876
690
        self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
877
691
 
878
692
 
879
 
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
 
693
class TestWin32FuncsDirs(TestCaseInTempDir):
880
694
    """Test win32 functions that create files."""
 
695
    
 
696
    def test_getcwd(self):
 
697
        if win32utils.winver == 'Windows 98':
 
698
            raise TestSkipped('Windows 98 cannot handle unicode filenames')
 
699
        # Make sure getcwd can handle unicode filenames
 
700
        try:
 
701
            os.mkdir(u'mu-\xb5')
 
702
        except UnicodeError:
 
703
            raise TestSkipped("Unable to create Unicode filename")
881
704
 
882
 
    def test_getcwd(self):
883
 
        self.requireFeature(tests.UnicodeFilenameFeature)
884
 
        os.mkdir(u'mu-\xb5')
885
705
        os.chdir(u'mu-\xb5')
886
706
        # TODO: jam 20060427 This will probably fail on Mac OSX because
887
707
        #       it will change the normalization of B\xe5gfors
892
712
    def test_minimum_path_selection(self):
893
713
        self.assertEqual(set(),
894
714
            osutils.minimum_path_selection([]))
895
 
        self.assertEqual(set(['a']),
896
 
            osutils.minimum_path_selection(['a']))
897
715
        self.assertEqual(set(['a', 'b']),
898
716
            osutils.minimum_path_selection(['a', 'b']))
899
717
        self.assertEqual(set(['a/', 'b']),
900
718
            osutils.minimum_path_selection(['a/', 'b']))
901
719
        self.assertEqual(set(['a/', 'b']),
902
720
            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
721
 
906
722
    def test_mkdtemp(self):
907
723
        tmpdir = osutils._win32_mkdtemp(dir='.')
963
779
        self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
964
780
 
965
781
 
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):
 
782
class TestMacFuncsDirs(TestCaseInTempDir):
976
783
    """Test mac special functions that require directories."""
977
784
 
978
785
    def test_getcwd(self):
979
 
        self.requireFeature(tests.UnicodeFilenameFeature)
980
 
        os.mkdir(u'B\xe5gfors')
 
786
        # On Mac, this will actually create Ba\u030agfors
 
787
        # but chdir will still work, because it accepts both paths
 
788
        try:
 
789
            os.mkdir(u'B\xe5gfors')
 
790
        except UnicodeError:
 
791
            raise TestSkipped("Unable to create Unicode filename")
 
792
 
981
793
        os.chdir(u'B\xe5gfors')
982
794
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
983
795
 
984
796
    def test_getcwd_nonnorm(self):
985
 
        self.requireFeature(tests.UnicodeFilenameFeature)
986
797
        # Test that _mac_getcwd() will normalize this path
987
 
        os.mkdir(u'Ba\u030agfors')
 
798
        try:
 
799
            os.mkdir(u'Ba\u030agfors')
 
800
        except UnicodeError:
 
801
            raise TestSkipped("Unable to create Unicode filename")
 
802
 
988
803
        os.chdir(u'Ba\u030agfors')
989
804
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
990
805
 
991
806
 
992
 
class TestChunksToLines(tests.TestCase):
 
807
class TestChunksToLines(TestCase):
993
808
 
994
809
    def test_smoketest(self):
995
810
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
999
814
 
1000
815
    def test_osutils_binding(self):
1001
816
        from bzrlib.tests import test__chunks_to_lines
1002
 
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
 
817
        if test__chunks_to_lines.CompiledChunksToLinesFeature.available():
1003
818
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1004
819
        else:
1005
820
            from bzrlib._chunks_to_lines_py import chunks_to_lines
1006
821
        self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
1007
822
 
1008
823
 
1009
 
class TestSplitLines(tests.TestCase):
 
824
class TestSplitLines(TestCase):
1010
825
 
1011
826
    def test_split_unicode(self):
1012
827
        self.assertEqual([u'foo\n', u'bar\xae'],
1019
834
                         osutils.split_lines('foo\rbar\n'))
1020
835
 
1021
836
 
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])
 
837
class TestWalkDirs(TestCaseInTempDir):
1028
838
 
1029
839
    def test_walkdirs(self):
1030
840
        tree = [
1063
873
            result.append((dirdetail, dirblock))
1064
874
 
1065
875
        self.assertTrue(found_bzrdir)
1066
 
        self.assertExpectedBlocks(expected_dirblocks, result)
 
876
        self.assertEqual(expected_dirblocks,
 
877
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1067
878
        # you can search a subdir only, with a supplied prefix.
1068
879
        result = []
1069
880
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
1070
881
            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")
 
882
        self.assertEqual(expected_dirblocks[1:],
 
883
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1092
884
 
1093
885
    def test__walkdirs_utf8(self):
1094
886
        tree = [
1127
919
            result.append((dirdetail, dirblock))
1128
920
 
1129
921
        self.assertTrue(found_bzrdir)
1130
 
        self.assertExpectedBlocks(expected_dirblocks, result)
1131
 
 
 
922
        self.assertEqual(expected_dirblocks,
 
923
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1132
924
        # you can search a subdir only, with a supplied prefix.
1133
925
        result = []
1134
926
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
1135
927
            result.append(dirblock)
1136
 
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
 
928
        self.assertEqual(expected_dirblocks[1:],
 
929
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1137
930
 
1138
931
    def _filter_out_stat(self, result):
1139
932
        """Filter out the stat value from the walkdirs result"""
1145
938
            dirblock[:] = new_dirblock
1146
939
 
1147
940
    def _save_platform_info(self):
1148
 
        self.overrideAttr(win32utils, 'winver')
1149
 
        self.overrideAttr(osutils, '_fs_enc')
1150
 
        self.overrideAttr(osutils, '_selected_dir_reader')
 
941
        cur_winver = win32utils.winver
 
942
        cur_fs_enc = osutils._fs_enc
 
943
        cur_dir_reader = osutils._selected_dir_reader
 
944
        def restore():
 
945
            win32utils.winver = cur_winver
 
946
            osutils._fs_enc = cur_fs_enc
 
947
            osutils._selected_dir_reader = cur_dir_reader
 
948
        self.addCleanup(restore)
1151
949
 
1152
 
    def assertDirReaderIs(self, expected):
 
950
    def assertReadFSDirIs(self, expected):
1153
951
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
1154
952
        # Force it to redetect
1155
953
        osutils._selected_dir_reader = None
1162
960
        self._save_platform_info()
1163
961
        win32utils.winver = None # Avoid the win32 detection code
1164
962
        osutils._fs_enc = 'UTF-8'
1165
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
963
        self.assertReadFSDirIs(UTF8DirReaderFeature.reader)
1166
964
 
1167
965
    def test_force_walkdirs_utf8_fs_ascii(self):
1168
966
        self.requireFeature(UTF8DirReaderFeature)
1169
967
        self._save_platform_info()
1170
968
        win32utils.winver = None # Avoid the win32 detection code
1171
969
        osutils._fs_enc = 'US-ASCII'
1172
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
970
        self.assertReadFSDirIs(UTF8DirReaderFeature.reader)
1173
971
 
1174
972
    def test_force_walkdirs_utf8_fs_ANSI(self):
1175
973
        self.requireFeature(UTF8DirReaderFeature)
1176
974
        self._save_platform_info()
1177
975
        win32utils.winver = None # Avoid the win32 detection code
1178
976
        osutils._fs_enc = 'ANSI_X3.4-1968'
1179
 
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
977
        self.assertReadFSDirIs(UTF8DirReaderFeature.reader)
1180
978
 
1181
979
    def test_force_walkdirs_utf8_fs_latin1(self):
1182
980
        self._save_platform_info()
1183
981
        win32utils.winver = None # Avoid the win32 detection code
1184
982
        osutils._fs_enc = 'latin1'
1185
 
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
983
        self.assertReadFSDirIs(osutils.UnicodeDirReader)
1186
984
 
1187
985
    def test_force_walkdirs_utf8_nt(self):
1188
986
        # Disabled because the thunk of the whole walkdirs api is disabled.
1189
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
987
        self.requireFeature(Win32ReadDirFeature)
1190
988
        self._save_platform_info()
1191
989
        win32utils.winver = 'Windows NT'
1192
990
        from bzrlib._walkdirs_win32 import Win32ReadDir
1193
 
        self.assertDirReaderIs(Win32ReadDir)
 
991
        self.assertReadFSDirIs(Win32ReadDir)
1194
992
 
1195
993
    def test_force_walkdirs_utf8_98(self):
1196
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
994
        self.requireFeature(Win32ReadDirFeature)
1197
995
        self._save_platform_info()
1198
996
        win32utils.winver = 'Windows 98'
1199
 
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
997
        self.assertReadFSDirIs(osutils.UnicodeDirReader)
1200
998
 
1201
999
    def test_unicode_walkdirs(self):
1202
1000
        """Walkdirs should always return unicode paths."""
1203
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1204
1001
        name0 = u'0file-\xb6'
1205
1002
        name1 = u'1dir-\u062c\u0648'
1206
1003
        name2 = u'2file-\u0633'
1211
1008
            name1 + '/' + name1 + '/',
1212
1009
            name2,
1213
1010
            ]
1214
 
        self.build_tree(tree)
 
1011
        try:
 
1012
            self.build_tree(tree)
 
1013
        except UnicodeError:
 
1014
            raise TestSkipped('Could not represent Unicode chars'
 
1015
                              ' in current encoding.')
1215
1016
        expected_dirblocks = [
1216
1017
                ((u'', u'.'),
1217
1018
                 [(name0, name0, 'file', './' + name0),
1243
1044
 
1244
1045
        The abspath portion might be in unicode or utf-8
1245
1046
        """
1246
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1247
1047
        name0 = u'0file-\xb6'
1248
1048
        name1 = u'1dir-\u062c\u0648'
1249
1049
        name2 = u'2file-\u0633'
1254
1054
            name1 + '/' + name1 + '/',
1255
1055
            name2,
1256
1056
            ]
1257
 
        self.build_tree(tree)
 
1057
        try:
 
1058
            self.build_tree(tree)
 
1059
        except UnicodeError:
 
1060
            raise TestSkipped('Could not represent Unicode chars'
 
1061
                              ' in current encoding.')
1258
1062
        name0 = name0.encode('utf8')
1259
1063
        name1 = name1.encode('utf8')
1260
1064
        name2 = name2.encode('utf8')
1304
1108
 
1305
1109
        The abspath portion should be in unicode
1306
1110
        """
1307
 
        self.requireFeature(tests.UnicodeFilenameFeature)
1308
1111
        # Use the unicode reader. TODO: split into driver-and-driven unit
1309
1112
        # tests.
1310
1113
        self._save_platform_info()
1319
1122
            name1u + '/' + name1u + '/',
1320
1123
            name2u,
1321
1124
            ]
1322
 
        self.build_tree(tree)
 
1125
        try:
 
1126
            self.build_tree(tree)
 
1127
        except UnicodeError:
 
1128
            raise TestSkipped('Could not represent Unicode chars'
 
1129
                              ' in current encoding.')
1323
1130
        name0 = name0u.encode('utf8')
1324
1131
        name1 = name1u.encode('utf8')
1325
1132
        name2 = name2u.encode('utf8')
1350
1157
        self.assertEqual(expected_dirblocks, result)
1351
1158
 
1352
1159
    def test__walkdirs_utf8_win32readdir(self):
1353
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1160
        self.requireFeature(Win32ReadDirFeature)
1354
1161
        self.requireFeature(tests.UnicodeFilenameFeature)
1355
1162
        from bzrlib._walkdirs_win32 import Win32ReadDir
1356
1163
        self._save_platform_info()
1407
1214
 
1408
1215
    def test__walkdirs_utf_win32_find_file_stat_file(self):
1409
1216
        """make sure our Stat values are valid"""
1410
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1217
        self.requireFeature(Win32ReadDirFeature)
1411
1218
        self.requireFeature(tests.UnicodeFilenameFeature)
1412
1219
        from bzrlib._walkdirs_win32 import Win32ReadDir
1413
1220
        name0u = u'0file-\xb6'
1431
1238
 
1432
1239
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
1433
1240
        """make sure our Stat values are valid"""
1434
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1241
        self.requireFeature(Win32ReadDirFeature)
1435
1242
        self.requireFeature(tests.UnicodeFilenameFeature)
1436
1243
        from bzrlib._walkdirs_win32 import Win32ReadDir
1437
1244
        name0u = u'0dir-\u062c\u0648'
1522
1329
            sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
1523
1330
 
1524
1331
 
1525
 
class TestCopyTree(tests.TestCaseInTempDir):
1526
 
 
 
1332
class TestCopyTree(TestCaseInTempDir):
 
1333
    
1527
1334
    def test_copy_basic_tree(self):
1528
1335
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1529
1336
        osutils.copy_tree('source', 'target')
1538
1345
        self.assertEqual(['c'], os.listdir('target/b'))
1539
1346
 
1540
1347
    def test_copy_tree_symlinks(self):
1541
 
        self.requireFeature(tests.SymlinkFeature)
 
1348
        self.requireFeature(SymlinkFeature)
1542
1349
        self.build_tree(['source/'])
1543
1350
        os.symlink('a/generic/path', 'source/lnk')
1544
1351
        osutils.copy_tree('source', 'target')
1574
1381
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1575
1382
 
1576
1383
 
1577
 
class TestSetUnsetEnv(tests.TestCase):
 
1384
#class TestTerminalEncoding has been moved to test_osutils_encodings.py
 
1385
# [bialix] 2006/12/26
 
1386
 
 
1387
 
 
1388
class TestSetUnsetEnv(TestCase):
1578
1389
    """Test updating the environment"""
1579
1390
 
1580
1391
    def setUp(self):
1586
1397
        def cleanup():
1587
1398
            if 'BZR_TEST_ENV_VAR' in os.environ:
1588
1399
                del os.environ['BZR_TEST_ENV_VAR']
 
1400
 
1589
1401
        self.addCleanup(cleanup)
1590
1402
 
1591
1403
    def test_set(self):
1603
1415
 
1604
1416
    def test_unicode(self):
1605
1417
        """Environment can only contain plain strings
1606
 
 
 
1418
        
1607
1419
        So Unicode strings must be encoded.
1608
1420
        """
1609
 
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
1421
        uni_val, env_val = probe_unicode_in_user_encoding()
1610
1422
        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(),))
 
1423
            raise TestSkipped('Cannot find a unicode character that works in'
 
1424
                              ' encoding %s' % (osutils.get_user_encoding(),))
1614
1425
 
1615
1426
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
1616
1427
        self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
1624
1435
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
1625
1436
 
1626
1437
 
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):
 
1438
class TestLocalTimeOffset(TestCase):
 
1439
 
 
1440
    def test_local_time_offset(self):
 
1441
        """Test that local_time_offset() returns a sane value."""
 
1442
        offset = osutils.local_time_offset()
 
1443
        self.assertTrue(isinstance(offset, int))
 
1444
        # Test that the offset is no more than a eighteen hours in
 
1445
        # either direction.
 
1446
        # Time zone handling is system specific, so it is difficult to
 
1447
        # do more specific tests, but a value outside of this range is
 
1448
        # probably wrong.
 
1449
        eighteen_hours = 18 * 3600
 
1450
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
1451
 
 
1452
    def test_local_time_offset_with_timestamp(self):
 
1453
        """Test that local_time_offset() works with a timestamp."""
 
1454
        offset = osutils.local_time_offset(1000000000.1234567)
 
1455
        self.assertTrue(isinstance(offset, int))
 
1456
        eighteen_hours = 18 * 3600
 
1457
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
1458
 
 
1459
 
 
1460
class TestShaFileByName(TestCaseInTempDir):
 
1461
 
 
1462
    def test_sha_empty(self):
 
1463
        self.build_tree_contents([('foo', '')])
 
1464
        expected_sha = osutils.sha_string('')
 
1465
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1466
 
 
1467
    def test_sha_mixed_endings(self):
 
1468
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1469
        self.build_tree_contents([('foo', text)])
 
1470
        expected_sha = osutils.sha_string(text)
 
1471
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1472
 
 
1473
 
 
1474
class TestResourceLoading(TestCaseInTempDir):
1664
1475
 
1665
1476
    def test_resource_string(self):
1666
1477
        # test resource in bzrlib
1674
1485
            'yyy.xx')
1675
1486
        # test unknown resource
1676
1487
        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)