/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: Sabin Iacob
  • Date: 2009-03-23 14:59:43 UTC
  • mto: (4189.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4193.
  • Revision ID: iacobs@m0n5t3r.info-20090323145943-3s3p1px5q1rkh2e5
update FSF mailing address

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