~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: John Arbash Meinel
  • Date: 2009-08-25 18:45:40 UTC
  • mto: (4634.6.15 2.0)
  • mto: This revision was merged to the branch mainline in revision 4667.
  • Revision ID: john@arbash-meinel.com-20090825184540-6dn3xjq62xhgj2gq
Add support for skipping ghost nodes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for the osutils wrapper."""
18
18
 
 
19
from cStringIO import StringIO
19
20
import errno
20
21
import os
 
22
import re
21
23
import socket
22
24
import stat
23
25
import sys
 
26
import time
24
27
 
25
 
import bzrlib
26
28
from bzrlib import (
27
29
    errors,
28
30
    osutils,
 
31
    tests,
29
32
    win32utils,
30
33
    )
31
 
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
32
34
from bzrlib.tests import (
33
 
        StringIOWrapper,
34
 
        TestCase, 
35
 
        TestCaseInTempDir, 
36
 
        TestSkipped,
37
 
        )
38
 
 
39
 
 
40
 
class TestOSUtils(TestCaseInTempDir):
 
35
    file_utils,
 
36
    test__walkdirs_win32,
 
37
    )
 
38
 
 
39
 
 
40
class _UTF8DirReaderFeature(tests.Feature):
 
41
 
 
42
    def _probe(self):
 
43
        try:
 
44
            from bzrlib import _readdir_pyx
 
45
            self.reader = _readdir_pyx.UTF8DirReader
 
46
            return True
 
47
        except ImportError:
 
48
            return False
 
49
 
 
50
    def feature_name(self):
 
51
        return 'bzrlib._readdir_pyx'
 
52
 
 
53
UTF8DirReaderFeature = _UTF8DirReaderFeature()
 
54
 
 
55
 
 
56
def _already_unicode(s):
 
57
    return s
 
58
 
 
59
 
 
60
def _fs_enc_to_unicode(s):
 
61
    return s.decode(osutils._fs_enc)
 
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.Win32ReadDirFeature.available():
 
87
        try:
 
88
            from bzrlib import _walkdirs_win32
 
89
            # TODO: check on windows, it may be that we need to use/add
 
90
            # safe_unicode instead of _fs_enc_to_unicode
 
91
            scenarios.append(
 
92
                ('win32',
 
93
                 dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
 
94
                      _native_to_unicode=_fs_enc_to_unicode)))
 
95
        except ImportError:
 
96
            pass
 
97
    return scenarios
 
98
 
 
99
 
 
100
def load_tests(basic_tests, module, loader):
 
101
    suite = loader.suiteClass()
 
102
    dir_reader_tests, remaining_tests = tests.split_suite_by_condition(
 
103
        basic_tests, tests.condition_isinstance(TestDirReader))
 
104
    tests.multiply_tests(dir_reader_tests, dir_reader_scenarios(), suite)
 
105
    suite.addTest(remaining_tests)
 
106
    return suite
 
107
 
 
108
 
 
109
class TestContainsWhitespace(tests.TestCase):
41
110
 
42
111
    def test_contains_whitespace(self):
43
112
        self.failUnless(osutils.contains_whitespace(u' '))
53
122
        self.failIf(osutils.contains_whitespace(u'hellothere'))
54
123
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
55
124
 
 
125
 
 
126
class TestRename(tests.TestCaseInTempDir):
 
127
 
56
128
    def test_fancy_rename(self):
57
129
        # This should work everywhere
58
130
        def rename(a, b):
86
158
 
87
159
    # TODO: test fancy_rename using a MemoryTransport
88
160
 
 
161
    def test_rename_change_case(self):
 
162
        # on Windows we should be able to change filename case by rename
 
163
        self.build_tree(['a', 'b/'])
 
164
        osutils.rename('a', 'A')
 
165
        osutils.rename('b', 'B')
 
166
        # we can't use failUnlessExists on case-insensitive filesystem
 
167
        # so try to check shape of the tree
 
168
        shape = sorted(os.listdir('.'))
 
169
        self.assertEquals(['A', 'B'], shape)
 
170
 
 
171
 
 
172
class TestRandChars(tests.TestCase):
 
173
 
89
174
    def test_01_rand_chars_empty(self):
90
175
        result = osutils.rand_chars(0)
91
176
        self.assertEqual(result, '')
96
181
        self.assertEqual(type(result), str)
97
182
        self.assertContainsRe(result, r'^[a-z0-9]{100}$')
98
183
 
 
184
 
 
185
class TestIsInside(tests.TestCase):
 
186
 
99
187
    def test_is_inside(self):
100
188
        is_inside = osutils.is_inside
101
189
        self.assertTrue(is_inside('src', 'src/foo.c'))
105
193
        self.assertFalse(is_inside('foo.c', ''))
106
194
        self.assertTrue(is_inside('', 'foo.c'))
107
195
 
 
196
    def test_is_inside_any(self):
 
197
        SRC_FOO_C = osutils.pathjoin('src', 'foo.c')
 
198
        for dirs, fn in [(['src', 'doc'], SRC_FOO_C),
 
199
                         (['src'], SRC_FOO_C),
 
200
                         (['src'], 'src'),
 
201
                         ]:
 
202
            self.assert_(osutils.is_inside_any(dirs, fn))
 
203
        for dirs, fn in [(['src'], 'srccontrol'),
 
204
                         (['src'], 'srccontrol/foo')]:
 
205
            self.assertFalse(osutils.is_inside_any(dirs, fn))
 
206
 
 
207
    def test_is_inside_or_parent_of_any(self):
 
208
        for dirs, fn in [(['src', 'doc'], 'src/foo.c'),
 
209
                         (['src'], 'src/foo.c'),
 
210
                         (['src/bar.c'], 'src'),
 
211
                         (['src/bar.c', 'bla/foo.c'], 'src'),
 
212
                         (['src'], 'src'),
 
213
                         ]:
 
214
            self.assert_(osutils.is_inside_or_parent_of_any(dirs, fn))
 
215
 
 
216
        for dirs, fn in [(['src'], 'srccontrol'),
 
217
                         (['srccontrol/foo.c'], 'src'),
 
218
                         (['src'], 'srccontrol/foo')]:
 
219
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
 
220
 
 
221
 
 
222
class TestRmTree(tests.TestCaseInTempDir):
 
223
 
108
224
    def test_rmtree(self):
109
225
        # Check to remove tree with read-only files/dirs
110
226
        os.mkdir('dir')
123
239
        self.failIfExists('dir/file')
124
240
        self.failIfExists('dir')
125
241
 
 
242
 
 
243
class TestDeleteAny(tests.TestCaseInTempDir):
 
244
 
 
245
    def test_delete_any_readonly(self):
 
246
        # from <https://bugs.launchpad.net/bzr/+bug/218206>
 
247
        self.build_tree(['d/', 'f'])
 
248
        osutils.make_readonly('d')
 
249
        osutils.make_readonly('f')
 
250
 
 
251
        osutils.delete_any('f')
 
252
        osutils.delete_any('d')
 
253
 
 
254
 
 
255
class TestKind(tests.TestCaseInTempDir):
 
256
 
126
257
    def test_file_kind(self):
127
258
        self.build_tree(['file', 'dir/'])
128
259
        self.assertEquals('file', osutils.file_kind('file'))
130
261
        if osutils.has_symlinks():
131
262
            os.symlink('symlink', 'symlink')
132
263
            self.assertEquals('symlink', osutils.file_kind('symlink'))
133
 
        
 
264
 
134
265
        # TODO: jam 20060529 Test a block device
135
266
        try:
136
267
            os.lstat('/dev/null')
158
289
                os.remove('socket')
159
290
 
160
291
    def test_kind_marker(self):
161
 
        self.assertEqual(osutils.kind_marker('file'), '')
162
 
        self.assertEqual(osutils.kind_marker('directory'), '/')
163
 
        self.assertEqual(osutils.kind_marker('symlink'), '@')
164
 
        self.assertEqual(osutils.kind_marker('tree-reference'), '+')
 
292
        self.assertEqual("", osutils.kind_marker("file"))
 
293
        self.assertEqual("/", osutils.kind_marker('directory'))
 
294
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
 
295
        self.assertEqual("@", osutils.kind_marker("symlink"))
 
296
        self.assertEqual("+", osutils.kind_marker("tree-reference"))
 
297
        self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
 
298
 
 
299
 
 
300
class TestUmask(tests.TestCaseInTempDir):
165
301
 
166
302
    def test_get_umask(self):
167
303
        if sys.platform == 'win32':
170
306
            return
171
307
 
172
308
        orig_umask = osutils.get_umask()
173
 
        try:
174
 
            os.umask(0222)
175
 
            self.assertEqual(0222, osutils.get_umask())
176
 
            os.umask(0022)
177
 
            self.assertEqual(0022, osutils.get_umask())
178
 
            os.umask(0002)
179
 
            self.assertEqual(0002, osutils.get_umask())
180
 
            os.umask(0027)
181
 
            self.assertEqual(0027, osutils.get_umask())
182
 
        finally:
183
 
            os.umask(orig_umask)
 
309
        self.addCleanup(os.umask, orig_umask)
 
310
        os.umask(0222)
 
311
        self.assertEqual(0222, osutils.get_umask())
 
312
        os.umask(0022)
 
313
        self.assertEqual(0022, osutils.get_umask())
 
314
        os.umask(0002)
 
315
        self.assertEqual(0002, osutils.get_umask())
 
316
        os.umask(0027)
 
317
        self.assertEqual(0027, osutils.get_umask())
 
318
 
 
319
 
 
320
class TestDateTime(tests.TestCase):
184
321
 
185
322
    def assertFormatedDelta(self, expected, seconds):
186
323
        """Assert osutils.format_delta formats as expected"""
218
355
        self.assertFormatedDelta('1 second in the future', -1)
219
356
        self.assertFormatedDelta('2 seconds in the future', -2)
220
357
 
 
358
    def test_format_date(self):
 
359
        self.assertRaises(errors.UnsupportedTimezoneFormat,
 
360
            osutils.format_date, 0, timezone='foo')
 
361
        self.assertIsInstance(osutils.format_date(0), str)
 
362
        self.assertIsInstance(osutils.format_local_date(0), unicode)
 
363
        # Testing for the actual value of the local weekday without
 
364
        # duplicating the code from format_date is difficult.
 
365
        # Instead blackbox.test_locale should check for localized
 
366
        # dates once they do occur in output strings.
 
367
 
 
368
    def test_local_time_offset(self):
 
369
        """Test that local_time_offset() returns a sane value."""
 
370
        offset = osutils.local_time_offset()
 
371
        self.assertTrue(isinstance(offset, int))
 
372
        # Test that the offset is no more than a eighteen hours in
 
373
        # either direction.
 
374
        # Time zone handling is system specific, so it is difficult to
 
375
        # do more specific tests, but a value outside of this range is
 
376
        # probably wrong.
 
377
        eighteen_hours = 18 * 3600
 
378
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
379
 
 
380
    def test_local_time_offset_with_timestamp(self):
 
381
        """Test that local_time_offset() works with a timestamp."""
 
382
        offset = osutils.local_time_offset(1000000000.1234567)
 
383
        self.assertTrue(isinstance(offset, int))
 
384
        eighteen_hours = 18 * 3600
 
385
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
386
 
 
387
 
 
388
class TestLinks(tests.TestCaseInTempDir):
 
389
 
221
390
    def test_dereference_path(self):
222
 
        if not osutils.has_symlinks():
223
 
            raise TestSkipped('Symlinks are not supported on this platform')
 
391
        self.requireFeature(tests.SymlinkFeature)
224
392
        cwd = osutils.realpath('.')
225
393
        os.mkdir('bar')
226
394
        bar_path = osutils.pathjoin(cwd, 'bar')
229
397
        self.assertEqual(bar_path, osutils.realpath('./bar'))
230
398
        os.symlink('bar', 'foo')
231
399
        self.assertEqual(bar_path, osutils.realpath('./foo'))
232
 
        
 
400
 
233
401
        # Does not dereference terminal symlinks
234
402
        foo_path = osutils.pathjoin(cwd, 'foo')
235
403
        self.assertEqual(foo_path, osutils.dereference_path('./foo'))
246
414
        foo_baz_path = osutils.pathjoin(foo_path, 'baz')
247
415
        self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
248
416
 
249
 
 
250
417
    def test_changing_access(self):
251
418
        f = file('file', 'w')
252
419
        f.write('monkey')
254
421
 
255
422
        # Make a file readonly
256
423
        osutils.make_readonly('file')
257
 
        mode = osutils.lstat('file').st_mode
 
424
        mode = os.lstat('file').st_mode
258
425
        self.assertEqual(mode, mode & 0777555)
259
426
 
260
427
        # Make a file writable
261
428
        osutils.make_writable('file')
262
 
        mode = osutils.lstat('file').st_mode
 
429
        mode = os.lstat('file').st_mode
263
430
        self.assertEqual(mode, mode | 0200)
264
431
 
265
432
        if osutils.has_symlinks():
268
435
            osutils.make_readonly('dangling')
269
436
            osutils.make_writable('dangling')
270
437
 
271
 
 
272
 
    def test_kind_marker(self):
273
 
        self.assertEqual("", osutils.kind_marker("file"))
274
 
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
275
 
        self.assertEqual("@", osutils.kind_marker("symlink"))
276
 
        self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
277
 
 
278
 
 
279
 
class TestSafeUnicode(TestCase):
 
438
    def test_host_os_dereferences_symlinks(self):
 
439
        osutils.host_os_dereferences_symlinks()
 
440
 
 
441
 
 
442
class TestCanonicalRelPath(tests.TestCaseInTempDir):
 
443
 
 
444
    _test_needs_features = [tests.CaseInsCasePresFilenameFeature]
 
445
 
 
446
    def test_canonical_relpath_simple(self):
 
447
        f = file('MixedCaseName', 'w')
 
448
        f.close()
 
449
        # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
 
450
        real_base_dir = osutils.realpath(self.test_base_dir)
 
451
        actual = osutils.canonical_relpath(real_base_dir, 'mixedcasename')
 
452
        self.failUnlessEqual('work/MixedCaseName', actual)
 
453
 
 
454
    def test_canonical_relpath_missing_tail(self):
 
455
        os.mkdir('MixedCaseParent')
 
456
        # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
 
457
        real_base_dir = osutils.realpath(self.test_base_dir)
 
458
        actual = osutils.canonical_relpath(real_base_dir,
 
459
                                           'mixedcaseparent/nochild')
 
460
        self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
 
461
 
 
462
 
 
463
class TestPumpFile(tests.TestCase):
 
464
    """Test pumpfile method."""
 
465
 
 
466
    def setUp(self):
 
467
        tests.TestCase.setUp(self)
 
468
        # create a test datablock
 
469
        self.block_size = 512
 
470
        pattern = '0123456789ABCDEF'
 
471
        self.test_data = pattern * (3 * self.block_size / len(pattern))
 
472
        self.test_data_len = len(self.test_data)
 
473
 
 
474
    def test_bracket_block_size(self):
 
475
        """Read data in blocks with the requested read size bracketing the
 
476
        block size."""
 
477
        # make sure test data is larger than max read size
 
478
        self.assertTrue(self.test_data_len > self.block_size)
 
479
 
 
480
        from_file = file_utils.FakeReadFile(self.test_data)
 
481
        to_file = StringIO()
 
482
 
 
483
        # read (max / 2) bytes and verify read size wasn't affected
 
484
        num_bytes_to_read = self.block_size / 2
 
485
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
486
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
 
487
        self.assertEqual(from_file.get_read_count(), 1)
 
488
 
 
489
        # read (max) bytes and verify read size wasn't affected
 
490
        num_bytes_to_read = self.block_size
 
491
        from_file.reset_read_count()
 
492
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
493
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
 
494
        self.assertEqual(from_file.get_read_count(), 1)
 
495
 
 
496
        # read (max + 1) bytes and verify read size was limited
 
497
        num_bytes_to_read = self.block_size + 1
 
498
        from_file.reset_read_count()
 
499
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
500
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
501
        self.assertEqual(from_file.get_read_count(), 2)
 
502
 
 
503
        # finish reading the rest of the data
 
504
        num_bytes_to_read = self.test_data_len - to_file.tell()
 
505
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
506
 
 
507
        # report error if the data wasn't equal (we only report the size due
 
508
        # to the length of the data)
 
509
        response_data = to_file.getvalue()
 
510
        if response_data != self.test_data:
 
511
            message = "Data not equal.  Expected %d bytes, received %d."
 
512
            self.fail(message % (len(response_data), self.test_data_len))
 
513
 
 
514
    def test_specified_size(self):
 
515
        """Request a transfer larger than the maximum block size and verify
 
516
        that the maximum read doesn't exceed the block_size."""
 
517
        # make sure test data is larger than max read size
 
518
        self.assertTrue(self.test_data_len > self.block_size)
 
519
 
 
520
        # retrieve data in blocks
 
521
        from_file = file_utils.FakeReadFile(self.test_data)
 
522
        to_file = StringIO()
 
523
        osutils.pumpfile(from_file, to_file, self.test_data_len,
 
524
                         self.block_size)
 
525
 
 
526
        # verify read size was equal to the maximum read size
 
527
        self.assertTrue(from_file.get_max_read_size() > 0)
 
528
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
529
        self.assertEqual(from_file.get_read_count(), 3)
 
530
 
 
531
        # report error if the data wasn't equal (we only report the size due
 
532
        # to the length of the data)
 
533
        response_data = to_file.getvalue()
 
534
        if response_data != self.test_data:
 
535
            message = "Data not equal.  Expected %d bytes, received %d."
 
536
            self.fail(message % (len(response_data), self.test_data_len))
 
537
 
 
538
    def test_to_eof(self):
 
539
        """Read to end-of-file and verify that the reads are not larger than
 
540
        the maximum read size."""
 
541
        # make sure test data is larger than max read size
 
542
        self.assertTrue(self.test_data_len > self.block_size)
 
543
 
 
544
        # retrieve data to EOF
 
545
        from_file = file_utils.FakeReadFile(self.test_data)
 
546
        to_file = StringIO()
 
547
        osutils.pumpfile(from_file, to_file, -1, self.block_size)
 
548
 
 
549
        # verify read size was equal to the maximum read size
 
550
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
551
        self.assertEqual(from_file.get_read_count(), 4)
 
552
 
 
553
        # report error if the data wasn't equal (we only report the size due
 
554
        # to the length of the data)
 
555
        response_data = to_file.getvalue()
 
556
        if response_data != self.test_data:
 
557
            message = "Data not equal.  Expected %d bytes, received %d."
 
558
            self.fail(message % (len(response_data), self.test_data_len))
 
559
 
 
560
    def test_defaults(self):
 
561
        """Verifies that the default arguments will read to EOF -- this
 
562
        test verifies that any existing usages of pumpfile will not be broken
 
563
        with this new version."""
 
564
        # retrieve data using default (old) pumpfile method
 
565
        from_file = file_utils.FakeReadFile(self.test_data)
 
566
        to_file = StringIO()
 
567
        osutils.pumpfile(from_file, to_file)
 
568
 
 
569
        # report error if the data wasn't equal (we only report the size due
 
570
        # to the length of the data)
 
571
        response_data = to_file.getvalue()
 
572
        if response_data != self.test_data:
 
573
            message = "Data not equal.  Expected %d bytes, received %d."
 
574
            self.fail(message % (len(response_data), self.test_data_len))
 
575
 
 
576
    def test_report_activity(self):
 
577
        activity = []
 
578
        def log_activity(length, direction):
 
579
            activity.append((length, direction))
 
580
        from_file = StringIO(self.test_data)
 
581
        to_file = StringIO()
 
582
        osutils.pumpfile(from_file, to_file, buff_size=500,
 
583
                         report_activity=log_activity, direction='read')
 
584
        self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
 
585
                          (36, 'read')], activity)
 
586
 
 
587
        from_file = StringIO(self.test_data)
 
588
        to_file = StringIO()
 
589
        del activity[:]
 
590
        osutils.pumpfile(from_file, to_file, buff_size=500,
 
591
                         report_activity=log_activity, direction='write')
 
592
        self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
 
593
                          (36, 'write')], activity)
 
594
 
 
595
        # And with a limited amount of data
 
596
        from_file = StringIO(self.test_data)
 
597
        to_file = StringIO()
 
598
        del activity[:]
 
599
        osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
 
600
                         report_activity=log_activity, direction='read')
 
601
        self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
 
602
 
 
603
 
 
604
 
 
605
class TestPumpStringFile(tests.TestCase):
 
606
 
 
607
    def test_empty(self):
 
608
        output = StringIO()
 
609
        osutils.pump_string_file("", output)
 
610
        self.assertEqual("", output.getvalue())
 
611
 
 
612
    def test_more_than_segment_size(self):
 
613
        output = StringIO()
 
614
        osutils.pump_string_file("123456789", output, 2)
 
615
        self.assertEqual("123456789", output.getvalue())
 
616
 
 
617
    def test_segment_size(self):
 
618
        output = StringIO()
 
619
        osutils.pump_string_file("12", output, 2)
 
620
        self.assertEqual("12", output.getvalue())
 
621
 
 
622
    def test_segment_size_multiple(self):
 
623
        output = StringIO()
 
624
        osutils.pump_string_file("1234", output, 2)
 
625
        self.assertEqual("1234", output.getvalue())
 
626
 
 
627
 
 
628
class TestRelpath(tests.TestCase):
 
629
 
 
630
    def test_simple_relpath(self):
 
631
        cwd = osutils.getcwd()
 
632
        subdir = cwd + '/subdir'
 
633
        self.assertEqual('subdir', osutils.relpath(cwd, subdir))
 
634
 
 
635
    def test_deep_relpath(self):
 
636
        cwd = osutils.getcwd()
 
637
        subdir = cwd + '/sub/subsubdir'
 
638
        self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
 
639
 
 
640
    def test_not_relative(self):
 
641
        self.assertRaises(errors.PathNotChild,
 
642
                          osutils.relpath, 'C:/path', 'H:/path')
 
643
        self.assertRaises(errors.PathNotChild,
 
644
                          osutils.relpath, 'C:/', 'H:/path')
 
645
 
 
646
 
 
647
class TestSafeUnicode(tests.TestCase):
280
648
 
281
649
    def test_from_ascii_string(self):
282
650
        self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
291
659
        self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
292
660
 
293
661
    def test_bad_utf8_string(self):
294
 
        self.assertRaises(BzrBadParameterNotUnicode,
 
662
        self.assertRaises(errors.BzrBadParameterNotUnicode,
295
663
                          osutils.safe_unicode,
296
664
                          '\xbb\xbb')
297
665
 
298
666
 
299
 
class TestSafeUtf8(TestCase):
 
667
class TestSafeUtf8(tests.TestCase):
300
668
 
301
669
    def test_from_ascii_string(self):
302
670
        f = 'foobar'
312
680
        self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
313
681
 
314
682
    def test_bad_utf8_string(self):
315
 
        self.assertRaises(BzrBadParameterNotUnicode,
 
683
        self.assertRaises(errors.BzrBadParameterNotUnicode,
316
684
                          osutils.safe_utf8, '\xbb\xbb')
317
685
 
318
686
 
319
 
class TestSafeRevisionId(TestCase):
 
687
class TestSafeRevisionId(tests.TestCase):
320
688
 
321
689
    def test_from_ascii_string(self):
 
690
        # this shouldn't give a warning because it's getting an ascii string
322
691
        self.assertEqual('foobar', osutils.safe_revision_id('foobar'))
323
692
 
324
693
    def test_from_unicode_string_ascii_contents(self):
343
712
        self.assertEqual(None, osutils.safe_revision_id(None))
344
713
 
345
714
 
346
 
class TestSafeFileId(TestCase):
 
715
class TestSafeFileId(tests.TestCase):
347
716
 
348
717
    def test_from_ascii_string(self):
349
718
        self.assertEqual('foobar', osutils.safe_file_id('foobar'))
369
738
        self.assertEqual(None, osutils.safe_file_id(None))
370
739
 
371
740
 
372
 
class TestWin32Funcs(TestCase):
373
 
    """Test that the _win32 versions of os utilities return appropriate paths."""
 
741
class TestWin32Funcs(tests.TestCase):
 
742
    """Test that _win32 versions of os utilities return appropriate paths."""
374
743
 
375
744
    def test_abspath(self):
376
745
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
383
752
        self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
384
753
 
385
754
    def test_pathjoin(self):
386
 
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path', 'to', 'foo'))
387
 
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path\\to', 'C:\\foo'))
388
 
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path/to', 'C:/foo'))
389
 
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path/to/', 'foo'))
390
 
        self.assertEqual('/foo', osutils._win32_pathjoin('C:/path/to/', '/foo'))
391
 
        self.assertEqual('/foo', osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
 
755
        self.assertEqual('path/to/foo',
 
756
                         osutils._win32_pathjoin('path', 'to', 'foo'))
 
757
        self.assertEqual('C:/foo',
 
758
                         osutils._win32_pathjoin('path\\to', 'C:\\foo'))
 
759
        self.assertEqual('C:/foo',
 
760
                         osutils._win32_pathjoin('path/to', 'C:/foo'))
 
761
        self.assertEqual('path/to/foo',
 
762
                         osutils._win32_pathjoin('path/to/', 'foo'))
 
763
        self.assertEqual('/foo',
 
764
                         osutils._win32_pathjoin('C:/path/to/', '/foo'))
 
765
        self.assertEqual('/foo',
 
766
                         osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
392
767
 
393
768
    def test_normpath(self):
394
 
        self.assertEqual('path/to/foo', osutils._win32_normpath(r'path\\from\..\to\.\foo'))
395
 
        self.assertEqual('path/to/foo', osutils._win32_normpath('path//from/../to/./foo'))
 
769
        self.assertEqual('path/to/foo',
 
770
                         osutils._win32_normpath(r'path\\from\..\to\.\foo'))
 
771
        self.assertEqual('path/to/foo',
 
772
                         osutils._win32_normpath('path//from/../to/./foo'))
396
773
 
397
774
    def test_getcwd(self):
398
775
        cwd = osutils._win32_getcwd()
427
804
        self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
428
805
 
429
806
 
430
 
class TestWin32FuncsDirs(TestCaseInTempDir):
 
807
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
431
808
    """Test win32 functions that create files."""
432
 
    
 
809
 
433
810
    def test_getcwd(self):
434
 
        if win32utils.winver == 'Windows 98':
435
 
            raise TestSkipped('Windows 98 cannot handle unicode filenames')
436
 
        # Make sure getcwd can handle unicode filenames
437
 
        try:
438
 
            os.mkdir(u'mu-\xb5')
439
 
        except UnicodeError:
440
 
            raise TestSkipped("Unable to create Unicode filename")
441
 
 
 
811
        self.requireFeature(tests.UnicodeFilenameFeature)
 
812
        os.mkdir(u'mu-\xb5')
442
813
        os.chdir(u'mu-\xb5')
443
814
        # TODO: jam 20060427 This will probably fail on Mac OSX because
444
815
        #       it will change the normalization of B\xe5gfors
446
817
        #       osutils.getcwd() renormalize the path.
447
818
        self.assertEndsWith(osutils._win32_getcwd(), u'mu-\xb5')
448
819
 
 
820
    def test_minimum_path_selection(self):
 
821
        self.assertEqual(set(),
 
822
            osutils.minimum_path_selection([]))
 
823
        self.assertEqual(set(['a']),
 
824
            osutils.minimum_path_selection(['a']))
 
825
        self.assertEqual(set(['a', 'b']),
 
826
            osutils.minimum_path_selection(['a', 'b']))
 
827
        self.assertEqual(set(['a/', 'b']),
 
828
            osutils.minimum_path_selection(['a/', 'b']))
 
829
        self.assertEqual(set(['a/', 'b']),
 
830
            osutils.minimum_path_selection(['a/c', 'a/', 'b']))
 
831
        self.assertEqual(set(['a-b', 'a', 'a0b']),
 
832
            osutils.minimum_path_selection(['a-b', 'a/b', 'a0b', 'a']))
 
833
 
449
834
    def test_mkdtemp(self):
450
835
        tmpdir = osutils._win32_mkdtemp(dir='.')
451
836
        self.assertFalse('\\' in tmpdir)
506
891
        self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
507
892
 
508
893
 
509
 
class TestMacFuncsDirs(TestCaseInTempDir):
 
894
class TestParentDirectories(tests.TestCaseInTempDir):
 
895
    """Test osutils.parent_directories()"""
 
896
 
 
897
    def test_parent_directories(self):
 
898
        self.assertEqual([], osutils.parent_directories('a'))
 
899
        self.assertEqual(['a'], osutils.parent_directories('a/b'))
 
900
        self.assertEqual(['a/b', 'a'], osutils.parent_directories('a/b/c'))
 
901
 
 
902
 
 
903
class TestMacFuncsDirs(tests.TestCaseInTempDir):
510
904
    """Test mac special functions that require directories."""
511
905
 
512
906
    def test_getcwd(self):
513
 
        # On Mac, this will actually create Ba\u030agfors
514
 
        # but chdir will still work, because it accepts both paths
515
 
        try:
516
 
            os.mkdir(u'B\xe5gfors')
517
 
        except UnicodeError:
518
 
            raise TestSkipped("Unable to create Unicode filename")
519
 
 
 
907
        self.requireFeature(tests.UnicodeFilenameFeature)
 
908
        os.mkdir(u'B\xe5gfors')
520
909
        os.chdir(u'B\xe5gfors')
521
910
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
522
911
 
523
912
    def test_getcwd_nonnorm(self):
 
913
        self.requireFeature(tests.UnicodeFilenameFeature)
524
914
        # Test that _mac_getcwd() will normalize this path
525
 
        try:
526
 
            os.mkdir(u'Ba\u030agfors')
527
 
        except UnicodeError:
528
 
            raise TestSkipped("Unable to create Unicode filename")
529
 
 
 
915
        os.mkdir(u'Ba\u030agfors')
530
916
        os.chdir(u'Ba\u030agfors')
531
917
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
532
918
 
533
919
 
534
 
class TestSplitLines(TestCase):
 
920
class TestChunksToLines(tests.TestCase):
 
921
 
 
922
    def test_smoketest(self):
 
923
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
 
924
                         osutils.chunks_to_lines(['foo\nbar', '\nbaz\n']))
 
925
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
 
926
                         osutils.chunks_to_lines(['foo\n', 'bar\n', 'baz\n']))
 
927
 
 
928
    def test_osutils_binding(self):
 
929
        from bzrlib.tests import test__chunks_to_lines
 
930
        if test__chunks_to_lines.CompiledChunksToLinesFeature.available():
 
931
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
932
        else:
 
933
            from bzrlib._chunks_to_lines_py import chunks_to_lines
 
934
        self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
 
935
 
 
936
 
 
937
class TestSplitLines(tests.TestCase):
535
938
 
536
939
    def test_split_unicode(self):
537
940
        self.assertEqual([u'foo\n', u'bar\xae'],
544
947
                         osutils.split_lines('foo\rbar\n'))
545
948
 
546
949
 
547
 
class TestWalkDirs(TestCaseInTempDir):
 
950
class TestWalkDirs(tests.TestCaseInTempDir):
 
951
 
 
952
    def assertExpectedBlocks(self, expected, result):
 
953
        self.assertEqual(expected,
 
954
                         [(dirinfo, [line[0:3] for line in block])
 
955
                          for dirinfo, block in result])
548
956
 
549
957
    def test_walkdirs(self):
550
958
        tree = [
583
991
            result.append((dirdetail, dirblock))
584
992
 
585
993
        self.assertTrue(found_bzrdir)
586
 
        self.assertEqual(expected_dirblocks,
587
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
994
        self.assertExpectedBlocks(expected_dirblocks, result)
588
995
        # you can search a subdir only, with a supplied prefix.
589
996
        result = []
590
997
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
591
998
            result.append(dirblock)
592
 
        self.assertEqual(expected_dirblocks[1:],
593
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
999
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
 
1000
 
 
1001
    def test_walkdirs_os_error(self):
 
1002
        # <https://bugs.edge.launchpad.net/bzr/+bug/338653>
 
1003
        # Pyrex readdir didn't raise useful messages if it had an error
 
1004
        # reading the directory
 
1005
        if sys.platform == 'win32':
 
1006
            raise tests.TestNotApplicable(
 
1007
                "readdir IOError not tested on win32")
 
1008
        os.mkdir("test-unreadable")
 
1009
        os.chmod("test-unreadable", 0000)
 
1010
        # must chmod it back so that it can be removed
 
1011
        self.addCleanup(os.chmod, "test-unreadable", 0700)
 
1012
        # The error is not raised until the generator is actually evaluated.
 
1013
        # (It would be ok if it happened earlier but at the moment it
 
1014
        # doesn't.)
 
1015
        e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
 
1016
        self.assertEquals('./test-unreadable', e.filename)
 
1017
        self.assertEquals(errno.EACCES, e.errno)
 
1018
        # Ensure the message contains the file name
 
1019
        self.assertContainsRe(str(e), "\./test-unreadable")
594
1020
 
595
1021
    def test__walkdirs_utf8(self):
596
1022
        tree = [
629
1055
            result.append((dirdetail, dirblock))
630
1056
 
631
1057
        self.assertTrue(found_bzrdir)
632
 
        self.assertEqual(expected_dirblocks,
633
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1058
        self.assertExpectedBlocks(expected_dirblocks, result)
 
1059
 
634
1060
        # you can search a subdir only, with a supplied prefix.
635
1061
        result = []
636
1062
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
637
1063
            result.append(dirblock)
638
 
        self.assertEqual(expected_dirblocks[1:],
639
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1064
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
640
1065
 
641
1066
    def _filter_out_stat(self, result):
642
1067
        """Filter out the stat value from the walkdirs result"""
647
1072
                new_dirblock.append((info[0], info[1], info[2], info[4]))
648
1073
            dirblock[:] = new_dirblock
649
1074
 
 
1075
    def _save_platform_info(self):
 
1076
        cur_winver = win32utils.winver
 
1077
        cur_fs_enc = osutils._fs_enc
 
1078
        cur_dir_reader = osutils._selected_dir_reader
 
1079
        def restore():
 
1080
            win32utils.winver = cur_winver
 
1081
            osutils._fs_enc = cur_fs_enc
 
1082
            osutils._selected_dir_reader = cur_dir_reader
 
1083
        self.addCleanup(restore)
 
1084
 
 
1085
    def assertDirReaderIs(self, expected):
 
1086
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
 
1087
        # Force it to redetect
 
1088
        osutils._selected_dir_reader = None
 
1089
        # Nothing to list, but should still trigger the selection logic
 
1090
        self.assertEqual([(('', '.'), [])], list(osutils._walkdirs_utf8('.')))
 
1091
        self.assertIsInstance(osutils._selected_dir_reader, expected)
 
1092
 
 
1093
    def test_force_walkdirs_utf8_fs_utf8(self):
 
1094
        self.requireFeature(UTF8DirReaderFeature)
 
1095
        self._save_platform_info()
 
1096
        win32utils.winver = None # Avoid the win32 detection code
 
1097
        osutils._fs_enc = 'UTF-8'
 
1098
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1099
 
 
1100
    def test_force_walkdirs_utf8_fs_ascii(self):
 
1101
        self.requireFeature(UTF8DirReaderFeature)
 
1102
        self._save_platform_info()
 
1103
        win32utils.winver = None # Avoid the win32 detection code
 
1104
        osutils._fs_enc = 'US-ASCII'
 
1105
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1106
 
 
1107
    def test_force_walkdirs_utf8_fs_ANSI(self):
 
1108
        self.requireFeature(UTF8DirReaderFeature)
 
1109
        self._save_platform_info()
 
1110
        win32utils.winver = None # Avoid the win32 detection code
 
1111
        osutils._fs_enc = 'ANSI_X3.4-1968'
 
1112
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1113
 
 
1114
    def test_force_walkdirs_utf8_fs_latin1(self):
 
1115
        self._save_platform_info()
 
1116
        win32utils.winver = None # Avoid the win32 detection code
 
1117
        osutils._fs_enc = 'latin1'
 
1118
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
1119
 
 
1120
    def test_force_walkdirs_utf8_nt(self):
 
1121
        # Disabled because the thunk of the whole walkdirs api is disabled.
 
1122
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1123
        self._save_platform_info()
 
1124
        win32utils.winver = 'Windows NT'
 
1125
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1126
        self.assertDirReaderIs(Win32ReadDir)
 
1127
 
 
1128
    def test_force_walkdirs_utf8_98(self):
 
1129
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1130
        self._save_platform_info()
 
1131
        win32utils.winver = 'Windows 98'
 
1132
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
1133
 
650
1134
    def test_unicode_walkdirs(self):
651
1135
        """Walkdirs should always return unicode paths."""
 
1136
        self.requireFeature(tests.UnicodeFilenameFeature)
652
1137
        name0 = u'0file-\xb6'
653
1138
        name1 = u'1dir-\u062c\u0648'
654
1139
        name2 = u'2file-\u0633'
659
1144
            name1 + '/' + name1 + '/',
660
1145
            name2,
661
1146
            ]
662
 
        try:
663
 
            self.build_tree(tree)
664
 
        except UnicodeError:
665
 
            raise TestSkipped('Could not represent Unicode chars'
666
 
                              ' in current encoding.')
 
1147
        self.build_tree(tree)
667
1148
        expected_dirblocks = [
668
1149
                ((u'', u'.'),
669
1150
                 [(name0, name0, 'file', './' + name0),
695
1176
 
696
1177
        The abspath portion might be in unicode or utf-8
697
1178
        """
 
1179
        self.requireFeature(tests.UnicodeFilenameFeature)
698
1180
        name0 = u'0file-\xb6'
699
1181
        name1 = u'1dir-\u062c\u0648'
700
1182
        name2 = u'2file-\u0633'
705
1187
            name1 + '/' + name1 + '/',
706
1188
            name2,
707
1189
            ]
708
 
        try:
709
 
            self.build_tree(tree)
710
 
        except UnicodeError:
711
 
            raise TestSkipped('Could not represent Unicode chars'
712
 
                              ' in current encoding.')
 
1190
        self.build_tree(tree)
713
1191
        name0 = name0.encode('utf8')
714
1192
        name1 = name1.encode('utf8')
715
1193
        name2 = name2.encode('utf8')
754
1232
            result.append((dirdetail, new_dirblock))
755
1233
        self.assertEqual(expected_dirblocks, result)
756
1234
 
757
 
    def test_unicode__walkdirs_unicode_to_utf8(self):
758
 
        """walkdirs_unicode_to_utf8 should be a safe fallback everywhere
 
1235
    def test__walkdirs_utf8_with_unicode_fs(self):
 
1236
        """UnicodeDirReader should be a safe fallback everywhere
759
1237
 
760
1238
        The abspath portion should be in unicode
761
1239
        """
762
 
        name0u = u'0file-\xb6'
763
 
        name1u = u'1dir-\u062c\u0648'
764
 
        name2u = u'2file-\u0633'
765
 
        tree = [
766
 
            name0u,
767
 
            name1u + '/',
768
 
            name1u + '/' + name0u,
769
 
            name1u + '/' + name1u + '/',
770
 
            name2u,
771
 
            ]
 
1240
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1241
        # Use the unicode reader. TODO: split into driver-and-driven unit
 
1242
        # tests.
 
1243
        self._save_platform_info()
 
1244
        osutils._selected_dir_reader = osutils.UnicodeDirReader()
 
1245
        name0u = u'0file-\xb6'
 
1246
        name1u = u'1dir-\u062c\u0648'
 
1247
        name2u = u'2file-\u0633'
 
1248
        tree = [
 
1249
            name0u,
 
1250
            name1u + '/',
 
1251
            name1u + '/' + name0u,
 
1252
            name1u + '/' + name1u + '/',
 
1253
            name2u,
 
1254
            ]
 
1255
        self.build_tree(tree)
 
1256
        name0 = name0u.encode('utf8')
 
1257
        name1 = name1u.encode('utf8')
 
1258
        name2 = name2u.encode('utf8')
 
1259
 
 
1260
        # All of the abspaths should be in unicode, all of the relative paths
 
1261
        # should be in utf8
 
1262
        expected_dirblocks = [
 
1263
                (('', '.'),
 
1264
                 [(name0, name0, 'file', './' + name0u),
 
1265
                  (name1, name1, 'directory', './' + name1u),
 
1266
                  (name2, name2, 'file', './' + name2u),
 
1267
                 ]
 
1268
                ),
 
1269
                ((name1, './' + name1u),
 
1270
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1271
                                                        + '/' + name0u),
 
1272
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1273
                                                            + '/' + name1u),
 
1274
                 ]
 
1275
                ),
 
1276
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1277
                 [
 
1278
                 ]
 
1279
                ),
 
1280
            ]
 
1281
        result = list(osutils._walkdirs_utf8('.'))
 
1282
        self._filter_out_stat(result)
 
1283
        self.assertEqual(expected_dirblocks, result)
 
1284
 
 
1285
    def test__walkdirs_utf8_win32readdir(self):
 
1286
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1287
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1288
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1289
        self._save_platform_info()
 
1290
        osutils._selected_dir_reader = Win32ReadDir()
 
1291
        name0u = u'0file-\xb6'
 
1292
        name1u = u'1dir-\u062c\u0648'
 
1293
        name2u = u'2file-\u0633'
 
1294
        tree = [
 
1295
            name0u,
 
1296
            name1u + '/',
 
1297
            name1u + '/' + name0u,
 
1298
            name1u + '/' + name1u + '/',
 
1299
            name2u,
 
1300
            ]
 
1301
        self.build_tree(tree)
 
1302
        name0 = name0u.encode('utf8')
 
1303
        name1 = name1u.encode('utf8')
 
1304
        name2 = name2u.encode('utf8')
 
1305
 
 
1306
        # All of the abspaths should be in unicode, all of the relative paths
 
1307
        # should be in utf8
 
1308
        expected_dirblocks = [
 
1309
                (('', '.'),
 
1310
                 [(name0, name0, 'file', './' + name0u),
 
1311
                  (name1, name1, 'directory', './' + name1u),
 
1312
                  (name2, name2, 'file', './' + name2u),
 
1313
                 ]
 
1314
                ),
 
1315
                ((name1, './' + name1u),
 
1316
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1317
                                                        + '/' + name0u),
 
1318
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1319
                                                            + '/' + name1u),
 
1320
                 ]
 
1321
                ),
 
1322
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1323
                 [
 
1324
                 ]
 
1325
                ),
 
1326
            ]
 
1327
        result = list(osutils._walkdirs_utf8(u'.'))
 
1328
        self._filter_out_stat(result)
 
1329
        self.assertEqual(expected_dirblocks, result)
 
1330
 
 
1331
    def assertStatIsCorrect(self, path, win32stat):
 
1332
        os_stat = os.stat(path)
 
1333
        self.assertEqual(os_stat.st_size, win32stat.st_size)
 
1334
        self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
 
1335
        self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
 
1336
        self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
 
1337
        self.assertEqual(os_stat.st_dev, win32stat.st_dev)
 
1338
        self.assertEqual(os_stat.st_ino, win32stat.st_ino)
 
1339
        self.assertEqual(os_stat.st_mode, win32stat.st_mode)
 
1340
 
 
1341
    def test__walkdirs_utf_win32_find_file_stat_file(self):
 
1342
        """make sure our Stat values are valid"""
 
1343
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1344
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1345
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1346
        name0u = u'0file-\xb6'
 
1347
        name0 = name0u.encode('utf8')
 
1348
        self.build_tree([name0u])
 
1349
        # I hate to sleep() here, but I'm trying to make the ctime different
 
1350
        # from the mtime
 
1351
        time.sleep(2)
 
1352
        f = open(name0u, 'ab')
772
1353
        try:
773
 
            self.build_tree(tree)
774
 
        except UnicodeError:
775
 
            raise TestSkipped('Could not represent Unicode chars'
776
 
                              ' in current encoding.')
 
1354
            f.write('just a small update')
 
1355
        finally:
 
1356
            f.close()
 
1357
 
 
1358
        result = Win32ReadDir().read_dir('', u'.')
 
1359
        entry = result[0]
 
1360
        self.assertEqual((name0, name0, 'file'), entry[:3])
 
1361
        self.assertEqual(u'./' + name0u, entry[4])
 
1362
        self.assertStatIsCorrect(entry[4], entry[3])
 
1363
        self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
 
1364
 
 
1365
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
 
1366
        """make sure our Stat values are valid"""
 
1367
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1368
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1369
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1370
        name0u = u'0dir-\u062c\u0648'
777
1371
        name0 = name0u.encode('utf8')
778
 
        name1 = name1u.encode('utf8')
779
 
        name2 = name2u.encode('utf8')
 
1372
        self.build_tree([name0u + '/'])
780
1373
 
781
 
        # All of the abspaths should be in unicode, all of the relative paths
782
 
        # should be in utf8
783
 
        expected_dirblocks = [
784
 
                (('', '.'),
785
 
                 [(name0, name0, 'file', './' + name0u),
786
 
                  (name1, name1, 'directory', './' + name1u),
787
 
                  (name2, name2, 'file', './' + name2u),
788
 
                 ]
789
 
                ),
790
 
                ((name1, './' + name1u),
791
 
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
792
 
                                                        + '/' + name0u),
793
 
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
794
 
                                                            + '/' + name1u),
795
 
                 ]
796
 
                ),
797
 
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
798
 
                 [
799
 
                 ]
800
 
                ),
801
 
            ]
802
 
        result = list(osutils._walkdirs_unicode_to_utf8('.'))
803
 
        self._filter_out_stat(result)
804
 
        self.assertEqual(expected_dirblocks, result)
 
1374
        result = Win32ReadDir().read_dir('', u'.')
 
1375
        entry = result[0]
 
1376
        self.assertEqual((name0, name0, 'directory'), entry[:3])
 
1377
        self.assertEqual(u'./' + name0u, entry[4])
 
1378
        self.assertStatIsCorrect(entry[4], entry[3])
805
1379
 
806
1380
    def assertPathCompare(self, path_less, path_greater):
807
1381
        """check that path_less and path_greater compare correctly."""
881
1455
            sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
882
1456
 
883
1457
 
884
 
class TestCopyTree(TestCaseInTempDir):
885
 
    
 
1458
class TestCopyTree(tests.TestCaseInTempDir):
 
1459
 
886
1460
    def test_copy_basic_tree(self):
887
1461
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
888
1462
        osutils.copy_tree('source', 'target')
897
1471
        self.assertEqual(['c'], os.listdir('target/b'))
898
1472
 
899
1473
    def test_copy_tree_symlinks(self):
900
 
        if not osutils.has_symlinks():
901
 
            return
 
1474
        self.requireFeature(tests.SymlinkFeature)
902
1475
        self.build_tree(['source/'])
903
1476
        os.symlink('a/generic/path', 'source/lnk')
904
1477
        osutils.copy_tree('source', 'target')
934
1507
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
935
1508
 
936
1509
 
937
 
#class TestTerminalEncoding has been moved to test_osutils_encodings.py
938
 
# [bialix] 2006/12/26
939
 
 
940
 
 
941
 
class TestSetUnsetEnv(TestCase):
 
1510
class TestSetUnsetEnv(tests.TestCase):
942
1511
    """Test updating the environment"""
943
1512
 
944
1513
    def setUp(self):
968
1537
 
969
1538
    def test_unicode(self):
970
1539
        """Environment can only contain plain strings
971
 
        
 
1540
 
972
1541
        So Unicode strings must be encoded.
973
1542
        """
974
 
        # Try a few different characters, to see if we can get
975
 
        # one that will be valid in the user_encoding
976
 
        possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
977
 
        for uni_val in possible_vals:
978
 
            try:
979
 
                env_val = uni_val.encode(bzrlib.user_encoding)
980
 
            except UnicodeEncodeError:
981
 
                # Try a different character
982
 
                pass
983
 
            else:
984
 
                break
985
 
        else:
986
 
            raise TestSkipped('Cannot find a unicode character that works in'
987
 
                              ' encoding %s' % (bzrlib.user_encoding,))
 
1543
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
1544
        if uni_val is None:
 
1545
            raise tests.TestSkipped(
 
1546
                'Cannot find a unicode character that works in encoding %s'
 
1547
                % (osutils.get_user_encoding(),))
988
1548
 
989
1549
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
990
1550
        self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
998
1558
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
999
1559
 
1000
1560
 
1001
 
class TestLocalTimeOffset(TestCase):
1002
 
 
1003
 
    def test_local_time_offset(self):
1004
 
        """Test that local_time_offset() returns a sane value."""
1005
 
        offset = osutils.local_time_offset()
1006
 
        self.assertTrue(isinstance(offset, int))
1007
 
        # Test that the offset is no more than a eighteen hours in
1008
 
        # either direction.
1009
 
        # Time zone handling is system specific, so it is difficult to
1010
 
        # do more specific tests, but a value outside of this range is
1011
 
        # probably wrong.
1012
 
        eighteen_hours = 18 * 3600
1013
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
1014
 
 
1015
 
    def test_local_time_offset_with_timestamp(self):
1016
 
        """Test that local_time_offset() works with a timestamp."""
1017
 
        offset = osutils.local_time_offset(1000000000.1234567)
1018
 
        self.assertTrue(isinstance(offset, int))
1019
 
        eighteen_hours = 18 * 3600
1020
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
1561
class TestSizeShaFile(tests.TestCaseInTempDir):
 
1562
 
 
1563
    def test_sha_empty(self):
 
1564
        self.build_tree_contents([('foo', '')])
 
1565
        expected_sha = osutils.sha_string('')
 
1566
        f = open('foo')
 
1567
        self.addCleanup(f.close)
 
1568
        size, sha = osutils.size_sha_file(f)
 
1569
        self.assertEqual(0, size)
 
1570
        self.assertEqual(expected_sha, sha)
 
1571
 
 
1572
    def test_sha_mixed_endings(self):
 
1573
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1574
        self.build_tree_contents([('foo', text)])
 
1575
        expected_sha = osutils.sha_string(text)
 
1576
        f = open('foo')
 
1577
        self.addCleanup(f.close)
 
1578
        size, sha = osutils.size_sha_file(f)
 
1579
        self.assertEqual(38, size)
 
1580
        self.assertEqual(expected_sha, sha)
 
1581
 
 
1582
 
 
1583
class TestShaFileByName(tests.TestCaseInTempDir):
 
1584
 
 
1585
    def test_sha_empty(self):
 
1586
        self.build_tree_contents([('foo', '')])
 
1587
        expected_sha = osutils.sha_string('')
 
1588
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1589
 
 
1590
    def test_sha_mixed_endings(self):
 
1591
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1592
        self.build_tree_contents([('foo', text)])
 
1593
        expected_sha = osutils.sha_string(text)
 
1594
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1595
 
 
1596
 
 
1597
class TestResourceLoading(tests.TestCaseInTempDir):
 
1598
 
 
1599
    def test_resource_string(self):
 
1600
        # test resource in bzrlib
 
1601
        text = osutils.resource_string('bzrlib', 'debug.py')
 
1602
        self.assertContainsRe(text, "debug_flags = set()")
 
1603
        # test resource under bzrlib
 
1604
        text = osutils.resource_string('bzrlib.ui', 'text.py')
 
1605
        self.assertContainsRe(text, "class TextUIFactory")
 
1606
        # test unsupported package
 
1607
        self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
 
1608
            'yyy.xx')
 
1609
        # test unknown resource
 
1610
        self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
 
1611
 
 
1612
 
 
1613
class TestReCompile(tests.TestCase):
 
1614
 
 
1615
    def test_re_compile_checked(self):
 
1616
        r = osutils.re_compile_checked(r'A*', re.IGNORECASE)
 
1617
        self.assertTrue(r.match('aaaa'))
 
1618
        self.assertTrue(r.match('aAaA'))
 
1619
 
 
1620
    def test_re_compile_checked_error(self):
 
1621
        # like https://bugs.launchpad.net/bzr/+bug/251352
 
1622
        err = self.assertRaises(
 
1623
            errors.BzrCommandError,
 
1624
            osutils.re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1625
        self.assertEqual(
 
1626
            "Invalid regular expression in test case: '*': "
 
1627
            "nothing to repeat",
 
1628
            str(err))
 
1629
 
 
1630
 
 
1631
class TestDirReader(tests.TestCaseInTempDir):
 
1632
 
 
1633
    # Set by load_tests
 
1634
    _dir_reader_class = None
 
1635
    _native_to_unicode = None
 
1636
 
 
1637
    def setUp(self):
 
1638
        tests.TestCaseInTempDir.setUp(self)
 
1639
 
 
1640
        # Save platform specific info and reset it
 
1641
        cur_dir_reader = osutils._selected_dir_reader
 
1642
 
 
1643
        def restore():
 
1644
            osutils._selected_dir_reader = cur_dir_reader
 
1645
        self.addCleanup(restore)
 
1646
 
 
1647
        osutils._selected_dir_reader = self._dir_reader_class()
 
1648
 
 
1649
    def _get_ascii_tree(self):
 
1650
        tree = [
 
1651
            '0file',
 
1652
            '1dir/',
 
1653
            '1dir/0file',
 
1654
            '1dir/1dir/',
 
1655
            '2file'
 
1656
            ]
 
1657
        expected_dirblocks = [
 
1658
                (('', '.'),
 
1659
                 [('0file', '0file', 'file'),
 
1660
                  ('1dir', '1dir', 'directory'),
 
1661
                  ('2file', '2file', 'file'),
 
1662
                 ]
 
1663
                ),
 
1664
                (('1dir', './1dir'),
 
1665
                 [('1dir/0file', '0file', 'file'),
 
1666
                  ('1dir/1dir', '1dir', 'directory'),
 
1667
                 ]
 
1668
                ),
 
1669
                (('1dir/1dir', './1dir/1dir'),
 
1670
                 [
 
1671
                 ]
 
1672
                ),
 
1673
            ]
 
1674
        return tree, expected_dirblocks
 
1675
 
 
1676
    def test_walk_cur_dir(self):
 
1677
        tree, expected_dirblocks = self._get_ascii_tree()
 
1678
        self.build_tree(tree)
 
1679
        result = list(osutils._walkdirs_utf8('.'))
 
1680
        # Filter out stat and abspath
 
1681
        self.assertEqual(expected_dirblocks,
 
1682
                         [(dirinfo, [line[0:3] for line in block])
 
1683
                          for dirinfo, block in result])
 
1684
 
 
1685
    def test_walk_sub_dir(self):
 
1686
        tree, expected_dirblocks = self._get_ascii_tree()
 
1687
        self.build_tree(tree)
 
1688
        # you can search a subdir only, with a supplied prefix.
 
1689
        result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
 
1690
        # Filter out stat and abspath
 
1691
        self.assertEqual(expected_dirblocks[1:],
 
1692
                         [(dirinfo, [line[0:3] for line in block])
 
1693
                          for dirinfo, block in result])
 
1694
 
 
1695
    def _get_unicode_tree(self):
 
1696
        name0u = u'0file-\xb6'
 
1697
        name1u = u'1dir-\u062c\u0648'
 
1698
        name2u = u'2file-\u0633'
 
1699
        tree = [
 
1700
            name0u,
 
1701
            name1u + '/',
 
1702
            name1u + '/' + name0u,
 
1703
            name1u + '/' + name1u + '/',
 
1704
            name2u,
 
1705
            ]
 
1706
        name0 = name0u.encode('UTF-8')
 
1707
        name1 = name1u.encode('UTF-8')
 
1708
        name2 = name2u.encode('UTF-8')
 
1709
        expected_dirblocks = [
 
1710
                (('', '.'),
 
1711
                 [(name0, name0, 'file', './' + name0u),
 
1712
                  (name1, name1, 'directory', './' + name1u),
 
1713
                  (name2, name2, 'file', './' + name2u),
 
1714
                 ]
 
1715
                ),
 
1716
                ((name1, './' + name1u),
 
1717
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1718
                                                        + '/' + name0u),
 
1719
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1720
                                                            + '/' + name1u),
 
1721
                 ]
 
1722
                ),
 
1723
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1724
                 [
 
1725
                 ]
 
1726
                ),
 
1727
            ]
 
1728
        return tree, expected_dirblocks
 
1729
 
 
1730
    def _filter_out(self, raw_dirblocks):
 
1731
        """Filter out a walkdirs_utf8 result.
 
1732
 
 
1733
        stat field is removed, all native paths are converted to unicode
 
1734
        """
 
1735
        filtered_dirblocks = []
 
1736
        for dirinfo, block in raw_dirblocks:
 
1737
            dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
 
1738
            details = []
 
1739
            for line in block:
 
1740
                details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
 
1741
            filtered_dirblocks.append((dirinfo, details))
 
1742
        return filtered_dirblocks
 
1743
 
 
1744
    def test_walk_unicode_tree(self):
 
1745
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1746
        tree, expected_dirblocks = self._get_unicode_tree()
 
1747
        self.build_tree(tree)
 
1748
        result = list(osutils._walkdirs_utf8('.'))
 
1749
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1750
 
 
1751
    def test_symlink(self):
 
1752
        self.requireFeature(tests.SymlinkFeature)
 
1753
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1754
        target = u'target\N{Euro Sign}'
 
1755
        link_name = u'l\N{Euro Sign}nk'
 
1756
        os.symlink(target, link_name)
 
1757
        target_utf8 = target.encode('UTF-8')
 
1758
        link_name_utf8 = link_name.encode('UTF-8')
 
1759
        expected_dirblocks = [
 
1760
                (('', '.'),
 
1761
                 [(link_name_utf8, link_name_utf8,
 
1762
                   'symlink', './' + link_name),],
 
1763
                 )]
 
1764
        result = list(osutils._walkdirs_utf8('.'))
 
1765
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1766
 
 
1767
 
 
1768
class TestReadLink(tests.TestCaseInTempDir):
 
1769
    """Exposes os.readlink() problems and the osutils solution.
 
1770
 
 
1771
    The only guarantee offered by os.readlink(), starting with 2.6, is that a
 
1772
    unicode string will be returned if a unicode string is passed.
 
1773
 
 
1774
    But prior python versions failed to properly encode the passed unicode
 
1775
    string.
 
1776
    """
 
1777
    _test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
 
1778
 
 
1779
    def setUp(self):
 
1780
        super(tests.TestCaseInTempDir, self).setUp()
 
1781
        self.link = u'l\N{Euro Sign}ink'
 
1782
        self.target = u'targe\N{Euro Sign}t'
 
1783
        os.symlink(self.target, self.link)
 
1784
 
 
1785
    def test_os_readlink_link_encoding(self):
 
1786
        if sys.version_info < (2, 6):
 
1787
            self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
 
1788
        else:
 
1789
            self.assertEquals(self.target,  os.readlink(self.link))
 
1790
 
 
1791
    def test_os_readlink_link_decoding(self):
 
1792
        self.assertEquals(self.target.encode(osutils._fs_enc),
 
1793
                          os.readlink(self.link.encode(osutils._fs_enc)))
 
1794
 
 
1795
 
 
1796
class TestConcurrency(tests.TestCase):
 
1797
 
 
1798
    def test_local_concurrency(self):
 
1799
        concurrency = osutils.local_concurrency()
 
1800
        self.assertIsInstance(concurrency, int)