~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

(jelmer) Move more VersionedFiles-specific tests to bt.per_repository_vf.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005-2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Tests for the osutils wrapper."""
 
18
 
 
19
from cStringIO import StringIO
 
20
import errno
 
21
import os
 
22
import re
 
23
import socket
 
24
import sys
 
25
import time
 
26
 
 
27
from bzrlib import (
 
28
    errors,
 
29
    lazy_regex,
 
30
    osutils,
 
31
    symbol_versioning,
 
32
    tests,
 
33
    trace,
 
34
    win32utils,
 
35
    )
 
36
from bzrlib.tests import (
 
37
    features,
 
38
    file_utils,
 
39
    test__walkdirs_win32,
 
40
    )
 
41
from bzrlib.tests.scenarios import load_tests_apply_scenarios
 
42
 
 
43
 
 
44
class _UTF8DirReaderFeature(tests.Feature):
 
45
 
 
46
    def _probe(self):
 
47
        try:
 
48
            from bzrlib import _readdir_pyx
 
49
            self.reader = _readdir_pyx.UTF8DirReader
 
50
            return True
 
51
        except ImportError:
 
52
            return False
 
53
 
 
54
    def feature_name(self):
 
55
        return 'bzrlib._readdir_pyx'
 
56
 
 
57
UTF8DirReaderFeature = _UTF8DirReaderFeature()
 
58
 
 
59
term_ios_feature = tests.ModuleAvailableFeature('termios')
 
60
 
 
61
 
 
62
def _already_unicode(s):
 
63
    return s
 
64
 
 
65
 
 
66
def _utf8_to_unicode(s):
 
67
    return s.decode('UTF-8')
 
68
 
 
69
 
 
70
def dir_reader_scenarios():
 
71
    # For each dir reader we define:
 
72
 
 
73
    # - native_to_unicode: a function converting the native_abspath as returned
 
74
    #   by DirReader.read_dir to its unicode representation
 
75
 
 
76
    # UnicodeDirReader is the fallback, it should be tested on all platforms.
 
77
    scenarios = [('unicode',
 
78
                  dict(_dir_reader_class=osutils.UnicodeDirReader,
 
79
                       _native_to_unicode=_already_unicode))]
 
80
    # Some DirReaders are platform specific and even there they may not be
 
81
    # available.
 
82
    if UTF8DirReaderFeature.available():
 
83
        from bzrlib import _readdir_pyx
 
84
        scenarios.append(('utf8',
 
85
                          dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
 
86
                               _native_to_unicode=_utf8_to_unicode)))
 
87
 
 
88
    if test__walkdirs_win32.win32_readdir_feature.available():
 
89
        try:
 
90
            from bzrlib import _walkdirs_win32
 
91
            scenarios.append(
 
92
                ('win32',
 
93
                 dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
 
94
                      _native_to_unicode=_already_unicode)))
 
95
        except ImportError:
 
96
            pass
 
97
    return scenarios
 
98
 
 
99
 
 
100
load_tests = load_tests_apply_scenarios
 
101
 
 
102
 
 
103
class TestContainsWhitespace(tests.TestCase):
 
104
 
 
105
    def test_contains_whitespace(self):
 
106
        self.assertTrue(osutils.contains_whitespace(u' '))
 
107
        self.assertTrue(osutils.contains_whitespace(u'hello there'))
 
108
        self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
 
109
        self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
 
110
        self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
 
111
        self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
 
112
 
 
113
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
 
114
        # is whitespace, but we do not.
 
115
        self.assertFalse(osutils.contains_whitespace(u''))
 
116
        self.assertFalse(osutils.contains_whitespace(u'hellothere'))
 
117
        self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
 
118
 
 
119
 
 
120
class TestRename(tests.TestCaseInTempDir):
 
121
 
 
122
    def create_file(self, filename, content):
 
123
        f = open(filename, 'wb')
 
124
        try:
 
125
            f.write(content)
 
126
        finally:
 
127
            f.close()
 
128
 
 
129
    def _fancy_rename(self, a, b):
 
130
        osutils.fancy_rename(a, b, rename_func=os.rename,
 
131
                             unlink_func=os.unlink)
 
132
 
 
133
    def test_fancy_rename(self):
 
134
        # This should work everywhere
 
135
        self.create_file('a', 'something in a\n')
 
136
        self._fancy_rename('a', 'b')
 
137
        self.assertPathDoesNotExist('a')
 
138
        self.assertPathExists('b')
 
139
        self.check_file_contents('b', 'something in a\n')
 
140
 
 
141
        self.create_file('a', 'new something in a\n')
 
142
        self._fancy_rename('b', 'a')
 
143
 
 
144
        self.check_file_contents('a', 'something in a\n')
 
145
 
 
146
    def test_fancy_rename_fails_source_missing(self):
 
147
        # An exception should be raised, and the target should be left in place
 
148
        self.create_file('target', 'data in target\n')
 
149
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
150
                          'missingsource', 'target')
 
151
        self.assertPathExists('target')
 
152
        self.check_file_contents('target', 'data in target\n')
 
153
 
 
154
    def test_fancy_rename_fails_if_source_and_target_missing(self):
 
155
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
156
                          'missingsource', 'missingtarget')
 
157
 
 
158
    def test_rename(self):
 
159
        # Rename should be semi-atomic on all platforms
 
160
        self.create_file('a', 'something in a\n')
 
161
        osutils.rename('a', 'b')
 
162
        self.assertPathDoesNotExist('a')
 
163
        self.assertPathExists('b')
 
164
        self.check_file_contents('b', 'something in a\n')
 
165
 
 
166
        self.create_file('a', 'new something in a\n')
 
167
        osutils.rename('b', 'a')
 
168
 
 
169
        self.check_file_contents('a', 'something in a\n')
 
170
 
 
171
    # TODO: test fancy_rename using a MemoryTransport
 
172
 
 
173
    def test_rename_change_case(self):
 
174
        # on Windows we should be able to change filename case by rename
 
175
        self.build_tree(['a', 'b/'])
 
176
        osutils.rename('a', 'A')
 
177
        osutils.rename('b', 'B')
 
178
        # we can't use failUnlessExists on case-insensitive filesystem
 
179
        # so try to check shape of the tree
 
180
        shape = sorted(os.listdir('.'))
 
181
        self.assertEquals(['A', 'B'], shape)
 
182
 
 
183
 
 
184
class TestRandChars(tests.TestCase):
 
185
 
 
186
    def test_01_rand_chars_empty(self):
 
187
        result = osutils.rand_chars(0)
 
188
        self.assertEqual(result, '')
 
189
 
 
190
    def test_02_rand_chars_100(self):
 
191
        result = osutils.rand_chars(100)
 
192
        self.assertEqual(len(result), 100)
 
193
        self.assertEqual(type(result), str)
 
194
        self.assertContainsRe(result, r'^[a-z0-9]{100}$')
 
195
 
 
196
 
 
197
class TestIsInside(tests.TestCase):
 
198
 
 
199
    def test_is_inside(self):
 
200
        is_inside = osutils.is_inside
 
201
        self.assertTrue(is_inside('src', 'src/foo.c'))
 
202
        self.assertFalse(is_inside('src', 'srccontrol'))
 
203
        self.assertTrue(is_inside('src', 'src/a/a/a/foo.c'))
 
204
        self.assertTrue(is_inside('foo.c', 'foo.c'))
 
205
        self.assertFalse(is_inside('foo.c', ''))
 
206
        self.assertTrue(is_inside('', 'foo.c'))
 
207
 
 
208
    def test_is_inside_any(self):
 
209
        SRC_FOO_C = osutils.pathjoin('src', 'foo.c')
 
210
        for dirs, fn in [(['src', 'doc'], SRC_FOO_C),
 
211
                         (['src'], SRC_FOO_C),
 
212
                         (['src'], 'src'),
 
213
                         ]:
 
214
            self.assert_(osutils.is_inside_any(dirs, fn))
 
215
        for dirs, fn in [(['src'], 'srccontrol'),
 
216
                         (['src'], 'srccontrol/foo')]:
 
217
            self.assertFalse(osutils.is_inside_any(dirs, fn))
 
218
 
 
219
    def test_is_inside_or_parent_of_any(self):
 
220
        for dirs, fn in [(['src', 'doc'], 'src/foo.c'),
 
221
                         (['src'], 'src/foo.c'),
 
222
                         (['src/bar.c'], 'src'),
 
223
                         (['src/bar.c', 'bla/foo.c'], 'src'),
 
224
                         (['src'], 'src'),
 
225
                         ]:
 
226
            self.assert_(osutils.is_inside_or_parent_of_any(dirs, fn))
 
227
 
 
228
        for dirs, fn in [(['src'], 'srccontrol'),
 
229
                         (['srccontrol/foo.c'], 'src'),
 
230
                         (['src'], 'srccontrol/foo')]:
 
231
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
 
232
 
 
233
 
 
234
class TestLstat(tests.TestCaseInTempDir):
 
235
 
 
236
    def test_lstat_matches_fstat(self):
 
237
        # On Windows, lstat and fstat don't always agree, primarily in the
 
238
        # 'st_ino' and 'st_dev' fields. So we force them to be '0' in our
 
239
        # custom implementation.
 
240
        if sys.platform == 'win32':
 
241
            # We only have special lstat/fstat if we have the extension.
 
242
            # Without it, we may end up re-reading content when we don't have
 
243
            # to, but otherwise it doesn't effect correctness.
 
244
            self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
245
        f = open('test-file.txt', 'wb')
 
246
        self.addCleanup(f.close)
 
247
        f.write('some content\n')
 
248
        f.flush()
 
249
        self.assertEqualStat(osutils.fstat(f.fileno()),
 
250
                             osutils.lstat('test-file.txt'))
 
251
 
 
252
 
 
253
class TestRmTree(tests.TestCaseInTempDir):
 
254
 
 
255
    def test_rmtree(self):
 
256
        # Check to remove tree with read-only files/dirs
 
257
        os.mkdir('dir')
 
258
        f = file('dir/file', 'w')
 
259
        f.write('spam')
 
260
        f.close()
 
261
        # would like to also try making the directory readonly, but at the
 
262
        # moment python shutil.rmtree doesn't handle that properly - it would
 
263
        # need to chmod the directory before removing things inside it - deferred
 
264
        # for now -- mbp 20060505
 
265
        # osutils.make_readonly('dir')
 
266
        osutils.make_readonly('dir/file')
 
267
 
 
268
        osutils.rmtree('dir')
 
269
 
 
270
        self.assertPathDoesNotExist('dir/file')
 
271
        self.assertPathDoesNotExist('dir')
 
272
 
 
273
 
 
274
class TestDeleteAny(tests.TestCaseInTempDir):
 
275
 
 
276
    def test_delete_any_readonly(self):
 
277
        # from <https://bugs.launchpad.net/bzr/+bug/218206>
 
278
        self.build_tree(['d/', 'f'])
 
279
        osutils.make_readonly('d')
 
280
        osutils.make_readonly('f')
 
281
 
 
282
        osutils.delete_any('f')
 
283
        osutils.delete_any('d')
 
284
 
 
285
 
 
286
class TestKind(tests.TestCaseInTempDir):
 
287
 
 
288
    def test_file_kind(self):
 
289
        self.build_tree(['file', 'dir/'])
 
290
        self.assertEquals('file', osutils.file_kind('file'))
 
291
        self.assertEquals('directory', osutils.file_kind('dir/'))
 
292
        if osutils.has_symlinks():
 
293
            os.symlink('symlink', 'symlink')
 
294
            self.assertEquals('symlink', osutils.file_kind('symlink'))
 
295
 
 
296
        # TODO: jam 20060529 Test a block device
 
297
        try:
 
298
            os.lstat('/dev/null')
 
299
        except OSError, e:
 
300
            if e.errno not in (errno.ENOENT,):
 
301
                raise
 
302
        else:
 
303
            self.assertEquals('chardev', osutils.file_kind('/dev/null'))
 
304
 
 
305
        mkfifo = getattr(os, 'mkfifo', None)
 
306
        if mkfifo:
 
307
            mkfifo('fifo')
 
308
            try:
 
309
                self.assertEquals('fifo', osutils.file_kind('fifo'))
 
310
            finally:
 
311
                os.remove('fifo')
 
312
 
 
313
        AF_UNIX = getattr(socket, 'AF_UNIX', None)
 
314
        if AF_UNIX:
 
315
            s = socket.socket(AF_UNIX)
 
316
            s.bind('socket')
 
317
            try:
 
318
                self.assertEquals('socket', osutils.file_kind('socket'))
 
319
            finally:
 
320
                os.remove('socket')
 
321
 
 
322
    def test_kind_marker(self):
 
323
        self.assertEqual("", osutils.kind_marker("file"))
 
324
        self.assertEqual("/", osutils.kind_marker('directory'))
 
325
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
 
326
        self.assertEqual("@", osutils.kind_marker("symlink"))
 
327
        self.assertEqual("+", osutils.kind_marker("tree-reference"))
 
328
        self.assertEqual("", osutils.kind_marker("fifo"))
 
329
        self.assertEqual("", osutils.kind_marker("socket"))
 
330
        self.assertEqual("", osutils.kind_marker("unknown"))
 
331
 
 
332
 
 
333
class TestUmask(tests.TestCaseInTempDir):
 
334
 
 
335
    def test_get_umask(self):
 
336
        if sys.platform == 'win32':
 
337
            # umask always returns '0', no way to set it
 
338
            self.assertEqual(0, osutils.get_umask())
 
339
            return
 
340
 
 
341
        orig_umask = osutils.get_umask()
 
342
        self.addCleanup(os.umask, orig_umask)
 
343
        os.umask(0222)
 
344
        self.assertEqual(0222, osutils.get_umask())
 
345
        os.umask(0022)
 
346
        self.assertEqual(0022, osutils.get_umask())
 
347
        os.umask(0002)
 
348
        self.assertEqual(0002, osutils.get_umask())
 
349
        os.umask(0027)
 
350
        self.assertEqual(0027, osutils.get_umask())
 
351
 
 
352
 
 
353
class TestDateTime(tests.TestCase):
 
354
 
 
355
    def assertFormatedDelta(self, expected, seconds):
 
356
        """Assert osutils.format_delta formats as expected"""
 
357
        actual = osutils.format_delta(seconds)
 
358
        self.assertEqual(expected, actual)
 
359
 
 
360
    def test_format_delta(self):
 
361
        self.assertFormatedDelta('0 seconds ago', 0)
 
362
        self.assertFormatedDelta('1 second ago', 1)
 
363
        self.assertFormatedDelta('10 seconds ago', 10)
 
364
        self.assertFormatedDelta('59 seconds ago', 59)
 
365
        self.assertFormatedDelta('89 seconds ago', 89)
 
366
        self.assertFormatedDelta('1 minute, 30 seconds ago', 90)
 
367
        self.assertFormatedDelta('3 minutes, 0 seconds ago', 180)
 
368
        self.assertFormatedDelta('3 minutes, 1 second ago', 181)
 
369
        self.assertFormatedDelta('10 minutes, 15 seconds ago', 615)
 
370
        self.assertFormatedDelta('30 minutes, 59 seconds ago', 1859)
 
371
        self.assertFormatedDelta('31 minutes, 0 seconds ago', 1860)
 
372
        self.assertFormatedDelta('60 minutes, 0 seconds ago', 3600)
 
373
        self.assertFormatedDelta('89 minutes, 59 seconds ago', 5399)
 
374
        self.assertFormatedDelta('1 hour, 30 minutes ago', 5400)
 
375
        self.assertFormatedDelta('2 hours, 30 minutes ago', 9017)
 
376
        self.assertFormatedDelta('10 hours, 0 minutes ago', 36000)
 
377
        self.assertFormatedDelta('24 hours, 0 minutes ago', 86400)
 
378
        self.assertFormatedDelta('35 hours, 59 minutes ago', 129599)
 
379
        self.assertFormatedDelta('36 hours, 0 minutes ago', 129600)
 
380
        self.assertFormatedDelta('36 hours, 0 minutes ago', 129601)
 
381
        self.assertFormatedDelta('36 hours, 1 minute ago', 129660)
 
382
        self.assertFormatedDelta('36 hours, 1 minute ago', 129661)
 
383
        self.assertFormatedDelta('84 hours, 10 minutes ago', 303002)
 
384
 
 
385
        # We handle when time steps the wrong direction because computers
 
386
        # don't have synchronized clocks.
 
387
        self.assertFormatedDelta('84 hours, 10 minutes in the future', -303002)
 
388
        self.assertFormatedDelta('1 second in the future', -1)
 
389
        self.assertFormatedDelta('2 seconds in the future', -2)
 
390
 
 
391
    def test_format_date(self):
 
392
        self.assertRaises(errors.UnsupportedTimezoneFormat,
 
393
            osutils.format_date, 0, timezone='foo')
 
394
        self.assertIsInstance(osutils.format_date(0), str)
 
395
        self.assertIsInstance(osutils.format_local_date(0), unicode)
 
396
        # Testing for the actual value of the local weekday without
 
397
        # duplicating the code from format_date is difficult.
 
398
        # Instead blackbox.test_locale should check for localized
 
399
        # dates once they do occur in output strings.
 
400
 
 
401
    def test_format_date_with_offset_in_original_timezone(self):
 
402
        self.assertEqual("Thu 1970-01-01 00:00:00 +0000",
 
403
            osutils.format_date_with_offset_in_original_timezone(0))
 
404
        self.assertEqual("Fri 1970-01-02 03:46:40 +0000",
 
405
            osutils.format_date_with_offset_in_original_timezone(100000))
 
406
        self.assertEqual("Fri 1970-01-02 05:46:40 +0200",
 
407
            osutils.format_date_with_offset_in_original_timezone(100000, 7200))
 
408
 
 
409
    def test_local_time_offset(self):
 
410
        """Test that local_time_offset() returns a sane value."""
 
411
        offset = osutils.local_time_offset()
 
412
        self.assertTrue(isinstance(offset, int))
 
413
        # Test that the offset is no more than a eighteen hours in
 
414
        # either direction.
 
415
        # Time zone handling is system specific, so it is difficult to
 
416
        # do more specific tests, but a value outside of this range is
 
417
        # probably wrong.
 
418
        eighteen_hours = 18 * 3600
 
419
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
420
 
 
421
    def test_local_time_offset_with_timestamp(self):
 
422
        """Test that local_time_offset() works with a timestamp."""
 
423
        offset = osutils.local_time_offset(1000000000.1234567)
 
424
        self.assertTrue(isinstance(offset, int))
 
425
        eighteen_hours = 18 * 3600
 
426
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
427
 
 
428
 
 
429
class TestLinks(tests.TestCaseInTempDir):
 
430
 
 
431
    def test_dereference_path(self):
 
432
        self.requireFeature(tests.SymlinkFeature)
 
433
        cwd = osutils.realpath('.')
 
434
        os.mkdir('bar')
 
435
        bar_path = osutils.pathjoin(cwd, 'bar')
 
436
        # Using './' to avoid bug #1213894 (first path component not
 
437
        # dereferenced) in Python 2.4.1 and earlier
 
438
        self.assertEqual(bar_path, osutils.realpath('./bar'))
 
439
        os.symlink('bar', 'foo')
 
440
        self.assertEqual(bar_path, osutils.realpath('./foo'))
 
441
 
 
442
        # Does not dereference terminal symlinks
 
443
        foo_path = osutils.pathjoin(cwd, 'foo')
 
444
        self.assertEqual(foo_path, osutils.dereference_path('./foo'))
 
445
 
 
446
        # Dereferences parent symlinks
 
447
        os.mkdir('bar/baz')
 
448
        baz_path = osutils.pathjoin(bar_path, 'baz')
 
449
        self.assertEqual(baz_path, osutils.dereference_path('./foo/baz'))
 
450
 
 
451
        # Dereferences parent symlinks that are the first path element
 
452
        self.assertEqual(baz_path, osutils.dereference_path('foo/baz'))
 
453
 
 
454
        # Dereferences parent symlinks in absolute paths
 
455
        foo_baz_path = osutils.pathjoin(foo_path, 'baz')
 
456
        self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
 
457
 
 
458
    def test_changing_access(self):
 
459
        f = file('file', 'w')
 
460
        f.write('monkey')
 
461
        f.close()
 
462
 
 
463
        # Make a file readonly
 
464
        osutils.make_readonly('file')
 
465
        mode = os.lstat('file').st_mode
 
466
        self.assertEqual(mode, mode & 0777555)
 
467
 
 
468
        # Make a file writable
 
469
        osutils.make_writable('file')
 
470
        mode = os.lstat('file').st_mode
 
471
        self.assertEqual(mode, mode | 0200)
 
472
 
 
473
        if osutils.has_symlinks():
 
474
            # should not error when handed a symlink
 
475
            os.symlink('nonexistent', 'dangling')
 
476
            osutils.make_readonly('dangling')
 
477
            osutils.make_writable('dangling')
 
478
 
 
479
    def test_host_os_dereferences_symlinks(self):
 
480
        osutils.host_os_dereferences_symlinks()
 
481
 
 
482
 
 
483
class TestCanonicalRelPath(tests.TestCaseInTempDir):
 
484
 
 
485
    _test_needs_features = [tests.CaseInsCasePresFilenameFeature]
 
486
 
 
487
    def test_canonical_relpath_simple(self):
 
488
        f = file('MixedCaseName', 'w')
 
489
        f.close()
 
490
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
 
491
        self.assertEqual('work/MixedCaseName', actual)
 
492
 
 
493
    def test_canonical_relpath_missing_tail(self):
 
494
        os.mkdir('MixedCaseParent')
 
495
        actual = osutils.canonical_relpath(self.test_base_dir,
 
496
                                           'mixedcaseparent/nochild')
 
497
        self.assertEqual('work/MixedCaseParent/nochild', actual)
 
498
 
 
499
 
 
500
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
 
501
 
 
502
    def assertRelpath(self, expected, base, path):
 
503
        actual = osutils._cicp_canonical_relpath(base, path)
 
504
        self.assertEqual(expected, actual)
 
505
 
 
506
    def test_simple(self):
 
507
        self.build_tree(['MixedCaseName'])
 
508
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
509
        self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
 
510
 
 
511
    def test_subdir_missing_tail(self):
 
512
        self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
 
513
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
514
        self.assertRelpath('MixedCaseParent/a_child', base,
 
515
                           'MixedCaseParent/a_child')
 
516
        self.assertRelpath('MixedCaseParent/a_child', base,
 
517
                           'MixedCaseParent/A_Child')
 
518
        self.assertRelpath('MixedCaseParent/not_child', base,
 
519
                           'MixedCaseParent/not_child')
 
520
 
 
521
    def test_at_root_slash(self):
 
522
        # We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
 
523
        # check...
 
524
        if osutils.MIN_ABS_PATHLENGTH > 1:
 
525
            raise tests.TestSkipped('relpath requires %d chars'
 
526
                                    % osutils.MIN_ABS_PATHLENGTH)
 
527
        self.assertRelpath('foo', '/', '/foo')
 
528
 
 
529
    def test_at_root_drive(self):
 
530
        if sys.platform != 'win32':
 
531
            raise tests.TestNotApplicable('we can only test drive-letter relative'
 
532
                                          ' paths on Windows where we have drive'
 
533
                                          ' letters.')
 
534
        # see bug #322807
 
535
        # The specific issue is that when at the root of a drive, 'abspath'
 
536
        # returns "C:/" or just "/". However, the code assumes that abspath
 
537
        # always returns something like "C:/foo" or "/foo" (no trailing slash).
 
538
        self.assertRelpath('foo', 'C:/', 'C:/foo')
 
539
        self.assertRelpath('foo', 'X:/', 'X:/foo')
 
540
        self.assertRelpath('foo', 'X:/', 'X://foo')
 
541
 
 
542
 
 
543
class TestPumpFile(tests.TestCase):
 
544
    """Test pumpfile method."""
 
545
 
 
546
    def setUp(self):
 
547
        tests.TestCase.setUp(self)
 
548
        # create a test datablock
 
549
        self.block_size = 512
 
550
        pattern = '0123456789ABCDEF'
 
551
        self.test_data = pattern * (3 * self.block_size / len(pattern))
 
552
        self.test_data_len = len(self.test_data)
 
553
 
 
554
    def test_bracket_block_size(self):
 
555
        """Read data in blocks with the requested read size bracketing the
 
556
        block size."""
 
557
        # make sure test data is larger than max read size
 
558
        self.assertTrue(self.test_data_len > self.block_size)
 
559
 
 
560
        from_file = file_utils.FakeReadFile(self.test_data)
 
561
        to_file = StringIO()
 
562
 
 
563
        # read (max / 2) bytes and verify read size wasn't affected
 
564
        num_bytes_to_read = self.block_size / 2
 
565
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
566
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
 
567
        self.assertEqual(from_file.get_read_count(), 1)
 
568
 
 
569
        # read (max) bytes and verify read size wasn't affected
 
570
        num_bytes_to_read = self.block_size
 
571
        from_file.reset_read_count()
 
572
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
573
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
 
574
        self.assertEqual(from_file.get_read_count(), 1)
 
575
 
 
576
        # read (max + 1) bytes and verify read size was limited
 
577
        num_bytes_to_read = self.block_size + 1
 
578
        from_file.reset_read_count()
 
579
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
580
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
581
        self.assertEqual(from_file.get_read_count(), 2)
 
582
 
 
583
        # finish reading the rest of the data
 
584
        num_bytes_to_read = self.test_data_len - to_file.tell()
 
585
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
586
 
 
587
        # report error if the data wasn't equal (we only report the size due
 
588
        # to the length of the data)
 
589
        response_data = to_file.getvalue()
 
590
        if response_data != self.test_data:
 
591
            message = "Data not equal.  Expected %d bytes, received %d."
 
592
            self.fail(message % (len(response_data), self.test_data_len))
 
593
 
 
594
    def test_specified_size(self):
 
595
        """Request a transfer larger than the maximum block size and verify
 
596
        that the maximum read doesn't exceed the block_size."""
 
597
        # make sure test data is larger than max read size
 
598
        self.assertTrue(self.test_data_len > self.block_size)
 
599
 
 
600
        # retrieve data in blocks
 
601
        from_file = file_utils.FakeReadFile(self.test_data)
 
602
        to_file = StringIO()
 
603
        osutils.pumpfile(from_file, to_file, self.test_data_len,
 
604
                         self.block_size)
 
605
 
 
606
        # verify read size was equal to the maximum read size
 
607
        self.assertTrue(from_file.get_max_read_size() > 0)
 
608
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
609
        self.assertEqual(from_file.get_read_count(), 3)
 
610
 
 
611
        # report error if the data wasn't equal (we only report the size due
 
612
        # to the length of the data)
 
613
        response_data = to_file.getvalue()
 
614
        if response_data != self.test_data:
 
615
            message = "Data not equal.  Expected %d bytes, received %d."
 
616
            self.fail(message % (len(response_data), self.test_data_len))
 
617
 
 
618
    def test_to_eof(self):
 
619
        """Read to end-of-file and verify that the reads are not larger than
 
620
        the maximum read size."""
 
621
        # make sure test data is larger than max read size
 
622
        self.assertTrue(self.test_data_len > self.block_size)
 
623
 
 
624
        # retrieve data to EOF
 
625
        from_file = file_utils.FakeReadFile(self.test_data)
 
626
        to_file = StringIO()
 
627
        osutils.pumpfile(from_file, to_file, -1, self.block_size)
 
628
 
 
629
        # verify read size was equal to the maximum read size
 
630
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
 
631
        self.assertEqual(from_file.get_read_count(), 4)
 
632
 
 
633
        # report error if the data wasn't equal (we only report the size due
 
634
        # to the length of the data)
 
635
        response_data = to_file.getvalue()
 
636
        if response_data != self.test_data:
 
637
            message = "Data not equal.  Expected %d bytes, received %d."
 
638
            self.fail(message % (len(response_data), self.test_data_len))
 
639
 
 
640
    def test_defaults(self):
 
641
        """Verifies that the default arguments will read to EOF -- this
 
642
        test verifies that any existing usages of pumpfile will not be broken
 
643
        with this new version."""
 
644
        # retrieve data using default (old) pumpfile method
 
645
        from_file = file_utils.FakeReadFile(self.test_data)
 
646
        to_file = StringIO()
 
647
        osutils.pumpfile(from_file, to_file)
 
648
 
 
649
        # report error if the data wasn't equal (we only report the size due
 
650
        # to the length of the data)
 
651
        response_data = to_file.getvalue()
 
652
        if response_data != self.test_data:
 
653
            message = "Data not equal.  Expected %d bytes, received %d."
 
654
            self.fail(message % (len(response_data), self.test_data_len))
 
655
 
 
656
    def test_report_activity(self):
 
657
        activity = []
 
658
        def log_activity(length, direction):
 
659
            activity.append((length, direction))
 
660
        from_file = StringIO(self.test_data)
 
661
        to_file = StringIO()
 
662
        osutils.pumpfile(from_file, to_file, buff_size=500,
 
663
                         report_activity=log_activity, direction='read')
 
664
        self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
 
665
                          (36, 'read')], activity)
 
666
 
 
667
        from_file = StringIO(self.test_data)
 
668
        to_file = StringIO()
 
669
        del activity[:]
 
670
        osutils.pumpfile(from_file, to_file, buff_size=500,
 
671
                         report_activity=log_activity, direction='write')
 
672
        self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
 
673
                          (36, 'write')], activity)
 
674
 
 
675
        # And with a limited amount of data
 
676
        from_file = StringIO(self.test_data)
 
677
        to_file = StringIO()
 
678
        del activity[:]
 
679
        osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
 
680
                         report_activity=log_activity, direction='read')
 
681
        self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
 
682
 
 
683
 
 
684
 
 
685
class TestPumpStringFile(tests.TestCase):
 
686
 
 
687
    def test_empty(self):
 
688
        output = StringIO()
 
689
        osutils.pump_string_file("", output)
 
690
        self.assertEqual("", output.getvalue())
 
691
 
 
692
    def test_more_than_segment_size(self):
 
693
        output = StringIO()
 
694
        osutils.pump_string_file("123456789", output, 2)
 
695
        self.assertEqual("123456789", output.getvalue())
 
696
 
 
697
    def test_segment_size(self):
 
698
        output = StringIO()
 
699
        osutils.pump_string_file("12", output, 2)
 
700
        self.assertEqual("12", output.getvalue())
 
701
 
 
702
    def test_segment_size_multiple(self):
 
703
        output = StringIO()
 
704
        osutils.pump_string_file("1234", output, 2)
 
705
        self.assertEqual("1234", output.getvalue())
 
706
 
 
707
 
 
708
class TestRelpath(tests.TestCase):
 
709
 
 
710
    def test_simple_relpath(self):
 
711
        cwd = osutils.getcwd()
 
712
        subdir = cwd + '/subdir'
 
713
        self.assertEqual('subdir', osutils.relpath(cwd, subdir))
 
714
 
 
715
    def test_deep_relpath(self):
 
716
        cwd = osutils.getcwd()
 
717
        subdir = cwd + '/sub/subsubdir'
 
718
        self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
 
719
 
 
720
    def test_not_relative(self):
 
721
        self.assertRaises(errors.PathNotChild,
 
722
                          osutils.relpath, 'C:/path', 'H:/path')
 
723
        self.assertRaises(errors.PathNotChild,
 
724
                          osutils.relpath, 'C:/', 'H:/path')
 
725
 
 
726
 
 
727
class TestSafeUnicode(tests.TestCase):
 
728
 
 
729
    def test_from_ascii_string(self):
 
730
        self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
 
731
 
 
732
    def test_from_unicode_string_ascii_contents(self):
 
733
        self.assertEqual(u'bargam', osutils.safe_unicode(u'bargam'))
 
734
 
 
735
    def test_from_unicode_string_unicode_contents(self):
 
736
        self.assertEqual(u'bargam\xae', osutils.safe_unicode(u'bargam\xae'))
 
737
 
 
738
    def test_from_utf8_string(self):
 
739
        self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
 
740
 
 
741
    def test_bad_utf8_string(self):
 
742
        self.assertRaises(errors.BzrBadParameterNotUnicode,
 
743
                          osutils.safe_unicode,
 
744
                          '\xbb\xbb')
 
745
 
 
746
 
 
747
class TestSafeUtf8(tests.TestCase):
 
748
 
 
749
    def test_from_ascii_string(self):
 
750
        f = 'foobar'
 
751
        self.assertEqual('foobar', osutils.safe_utf8(f))
 
752
 
 
753
    def test_from_unicode_string_ascii_contents(self):
 
754
        self.assertEqual('bargam', osutils.safe_utf8(u'bargam'))
 
755
 
 
756
    def test_from_unicode_string_unicode_contents(self):
 
757
        self.assertEqual('bargam\xc2\xae', osutils.safe_utf8(u'bargam\xae'))
 
758
 
 
759
    def test_from_utf8_string(self):
 
760
        self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
 
761
 
 
762
    def test_bad_utf8_string(self):
 
763
        self.assertRaises(errors.BzrBadParameterNotUnicode,
 
764
                          osutils.safe_utf8, '\xbb\xbb')
 
765
 
 
766
 
 
767
class TestSafeRevisionId(tests.TestCase):
 
768
 
 
769
    def test_from_ascii_string(self):
 
770
        # this shouldn't give a warning because it's getting an ascii string
 
771
        self.assertEqual('foobar', osutils.safe_revision_id('foobar'))
 
772
 
 
773
    def test_from_unicode_string_ascii_contents(self):
 
774
        self.assertEqual('bargam',
 
775
                         osutils.safe_revision_id(u'bargam', warn=False))
 
776
 
 
777
    def test_from_unicode_deprecated(self):
 
778
        self.assertEqual('bargam',
 
779
            self.callDeprecated([osutils._revision_id_warning],
 
780
                                osutils.safe_revision_id, u'bargam'))
 
781
 
 
782
    def test_from_unicode_string_unicode_contents(self):
 
783
        self.assertEqual('bargam\xc2\xae',
 
784
                         osutils.safe_revision_id(u'bargam\xae', warn=False))
 
785
 
 
786
    def test_from_utf8_string(self):
 
787
        self.assertEqual('foo\xc2\xae',
 
788
                         osutils.safe_revision_id('foo\xc2\xae'))
 
789
 
 
790
    def test_none(self):
 
791
        """Currently, None is a valid revision_id"""
 
792
        self.assertEqual(None, osutils.safe_revision_id(None))
 
793
 
 
794
 
 
795
class TestSafeFileId(tests.TestCase):
 
796
 
 
797
    def test_from_ascii_string(self):
 
798
        self.assertEqual('foobar', osutils.safe_file_id('foobar'))
 
799
 
 
800
    def test_from_unicode_string_ascii_contents(self):
 
801
        self.assertEqual('bargam', osutils.safe_file_id(u'bargam', warn=False))
 
802
 
 
803
    def test_from_unicode_deprecated(self):
 
804
        self.assertEqual('bargam',
 
805
            self.callDeprecated([osutils._file_id_warning],
 
806
                                osutils.safe_file_id, u'bargam'))
 
807
 
 
808
    def test_from_unicode_string_unicode_contents(self):
 
809
        self.assertEqual('bargam\xc2\xae',
 
810
                         osutils.safe_file_id(u'bargam\xae', warn=False))
 
811
 
 
812
    def test_from_utf8_string(self):
 
813
        self.assertEqual('foo\xc2\xae',
 
814
                         osutils.safe_file_id('foo\xc2\xae'))
 
815
 
 
816
    def test_none(self):
 
817
        """Currently, None is a valid revision_id"""
 
818
        self.assertEqual(None, osutils.safe_file_id(None))
 
819
 
 
820
 
 
821
class TestWin32Funcs(tests.TestCase):
 
822
    """Test that _win32 versions of os utilities return appropriate paths."""
 
823
 
 
824
    def test_abspath(self):
 
825
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
 
826
        self.assertEqual('C:/foo', osutils._win32_abspath('C:/foo'))
 
827
        self.assertEqual('//HOST/path', osutils._win32_abspath(r'\\HOST\path'))
 
828
        self.assertEqual('//HOST/path', osutils._win32_abspath('//HOST/path'))
 
829
 
 
830
    def test_realpath(self):
 
831
        self.assertEqual('C:/foo', osutils._win32_realpath('C:\\foo'))
 
832
        self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
 
833
 
 
834
    def test_pathjoin(self):
 
835
        self.assertEqual('path/to/foo',
 
836
                         osutils._win32_pathjoin('path', 'to', 'foo'))
 
837
        self.assertEqual('C:/foo',
 
838
                         osutils._win32_pathjoin('path\\to', 'C:\\foo'))
 
839
        self.assertEqual('C:/foo',
 
840
                         osutils._win32_pathjoin('path/to', 'C:/foo'))
 
841
        self.assertEqual('path/to/foo',
 
842
                         osutils._win32_pathjoin('path/to/', 'foo'))
 
843
        self.assertEqual('/foo',
 
844
                         osutils._win32_pathjoin('C:/path/to/', '/foo'))
 
845
        self.assertEqual('/foo',
 
846
                         osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
 
847
 
 
848
    def test_normpath(self):
 
849
        self.assertEqual('path/to/foo',
 
850
                         osutils._win32_normpath(r'path\\from\..\to\.\foo'))
 
851
        self.assertEqual('path/to/foo',
 
852
                         osutils._win32_normpath('path//from/../to/./foo'))
 
853
 
 
854
    def test_getcwd(self):
 
855
        cwd = osutils._win32_getcwd()
 
856
        os_cwd = os.getcwdu()
 
857
        self.assertEqual(os_cwd[1:].replace('\\', '/'), cwd[1:])
 
858
        # win32 is inconsistent whether it returns lower or upper case
 
859
        # and even if it was consistent the user might type the other
 
860
        # so we force it to uppercase
 
861
        # running python.exe under cmd.exe return capital C:\\
 
862
        # running win32 python inside a cygwin shell returns lowercase
 
863
        self.assertEqual(os_cwd[0].upper(), cwd[0])
 
864
 
 
865
    def test_fixdrive(self):
 
866
        self.assertEqual('H:/foo', osutils._win32_fixdrive('h:/foo'))
 
867
        self.assertEqual('H:/foo', osutils._win32_fixdrive('H:/foo'))
 
868
        self.assertEqual('C:\\foo', osutils._win32_fixdrive('c:\\foo'))
 
869
 
 
870
    def test_win98_abspath(self):
 
871
        # absolute path
 
872
        self.assertEqual('C:/foo', osutils._win98_abspath('C:\\foo'))
 
873
        self.assertEqual('C:/foo', osutils._win98_abspath('C:/foo'))
 
874
        # UNC path
 
875
        self.assertEqual('//HOST/path', osutils._win98_abspath(r'\\HOST\path'))
 
876
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
 
877
        # relative path
 
878
        cwd = osutils.getcwd().rstrip('/')
 
879
        drive = osutils.ntpath.splitdrive(cwd)[0]
 
880
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
 
881
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
 
882
        # unicode path
 
883
        u = u'\u1234'
 
884
        self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
 
885
 
 
886
 
 
887
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
 
888
    """Test win32 functions that create files."""
 
889
 
 
890
    def test_getcwd(self):
 
891
        self.requireFeature(tests.UnicodeFilenameFeature)
 
892
        os.mkdir(u'mu-\xb5')
 
893
        os.chdir(u'mu-\xb5')
 
894
        # TODO: jam 20060427 This will probably fail on Mac OSX because
 
895
        #       it will change the normalization of B\xe5gfors
 
896
        #       Consider using a different unicode character, or make
 
897
        #       osutils.getcwd() renormalize the path.
 
898
        self.assertEndsWith(osutils._win32_getcwd(), u'mu-\xb5')
 
899
 
 
900
    def test_minimum_path_selection(self):
 
901
        self.assertEqual(set(),
 
902
            osutils.minimum_path_selection([]))
 
903
        self.assertEqual(set(['a']),
 
904
            osutils.minimum_path_selection(['a']))
 
905
        self.assertEqual(set(['a', 'b']),
 
906
            osutils.minimum_path_selection(['a', 'b']))
 
907
        self.assertEqual(set(['a/', 'b']),
 
908
            osutils.minimum_path_selection(['a/', 'b']))
 
909
        self.assertEqual(set(['a/', 'b']),
 
910
            osutils.minimum_path_selection(['a/c', 'a/', 'b']))
 
911
        self.assertEqual(set(['a-b', 'a', 'a0b']),
 
912
            osutils.minimum_path_selection(['a-b', 'a/b', 'a0b', 'a']))
 
913
 
 
914
    def test_mkdtemp(self):
 
915
        tmpdir = osutils._win32_mkdtemp(dir='.')
 
916
        self.assertFalse('\\' in tmpdir)
 
917
 
 
918
    def test_rename(self):
 
919
        a = open('a', 'wb')
 
920
        a.write('foo\n')
 
921
        a.close()
 
922
        b = open('b', 'wb')
 
923
        b.write('baz\n')
 
924
        b.close()
 
925
 
 
926
        osutils._win32_rename('b', 'a')
 
927
        self.assertPathExists('a')
 
928
        self.assertPathDoesNotExist('b')
 
929
        self.assertFileEqual('baz\n', 'a')
 
930
 
 
931
    def test_rename_missing_file(self):
 
932
        a = open('a', 'wb')
 
933
        a.write('foo\n')
 
934
        a.close()
 
935
 
 
936
        try:
 
937
            osutils._win32_rename('b', 'a')
 
938
        except (IOError, OSError), e:
 
939
            self.assertEqual(errno.ENOENT, e.errno)
 
940
        self.assertFileEqual('foo\n', 'a')
 
941
 
 
942
    def test_rename_missing_dir(self):
 
943
        os.mkdir('a')
 
944
        try:
 
945
            osutils._win32_rename('b', 'a')
 
946
        except (IOError, OSError), e:
 
947
            self.assertEqual(errno.ENOENT, e.errno)
 
948
 
 
949
    def test_rename_current_dir(self):
 
950
        os.mkdir('a')
 
951
        os.chdir('a')
 
952
        # You can't rename the working directory
 
953
        # doing rename non-existant . usually
 
954
        # just raises ENOENT, since non-existant
 
955
        # doesn't exist.
 
956
        try:
 
957
            osutils._win32_rename('b', '.')
 
958
        except (IOError, OSError), e:
 
959
            self.assertEqual(errno.ENOENT, e.errno)
 
960
 
 
961
    def test_splitpath(self):
 
962
        def check(expected, path):
 
963
            self.assertEqual(expected, osutils.splitpath(path))
 
964
 
 
965
        check(['a'], 'a')
 
966
        check(['a', 'b'], 'a/b')
 
967
        check(['a', 'b'], 'a/./b')
 
968
        check(['a', '.b'], 'a/.b')
 
969
        check(['a', '.b'], 'a\\.b')
 
970
 
 
971
        self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
 
972
 
 
973
 
 
974
class TestParentDirectories(tests.TestCaseInTempDir):
 
975
    """Test osutils.parent_directories()"""
 
976
 
 
977
    def test_parent_directories(self):
 
978
        self.assertEqual([], osutils.parent_directories('a'))
 
979
        self.assertEqual(['a'], osutils.parent_directories('a/b'))
 
980
        self.assertEqual(['a/b', 'a'], osutils.parent_directories('a/b/c'))
 
981
 
 
982
 
 
983
class TestMacFuncsDirs(tests.TestCaseInTempDir):
 
984
    """Test mac special functions that require directories."""
 
985
 
 
986
    def test_getcwd(self):
 
987
        self.requireFeature(tests.UnicodeFilenameFeature)
 
988
        os.mkdir(u'B\xe5gfors')
 
989
        os.chdir(u'B\xe5gfors')
 
990
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
 
991
 
 
992
    def test_getcwd_nonnorm(self):
 
993
        self.requireFeature(tests.UnicodeFilenameFeature)
 
994
        # Test that _mac_getcwd() will normalize this path
 
995
        os.mkdir(u'Ba\u030agfors')
 
996
        os.chdir(u'Ba\u030agfors')
 
997
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
 
998
 
 
999
 
 
1000
class TestChunksToLines(tests.TestCase):
 
1001
 
 
1002
    def test_smoketest(self):
 
1003
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
 
1004
                         osutils.chunks_to_lines(['foo\nbar', '\nbaz\n']))
 
1005
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
 
1006
                         osutils.chunks_to_lines(['foo\n', 'bar\n', 'baz\n']))
 
1007
 
 
1008
    def test_osutils_binding(self):
 
1009
        from bzrlib.tests import test__chunks_to_lines
 
1010
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
 
1011
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1012
        else:
 
1013
            from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1014
        self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
 
1015
 
 
1016
 
 
1017
class TestSplitLines(tests.TestCase):
 
1018
 
 
1019
    def test_split_unicode(self):
 
1020
        self.assertEqual([u'foo\n', u'bar\xae'],
 
1021
                         osutils.split_lines(u'foo\nbar\xae'))
 
1022
        self.assertEqual([u'foo\n', u'bar\xae\n'],
 
1023
                         osutils.split_lines(u'foo\nbar\xae\n'))
 
1024
 
 
1025
    def test_split_with_carriage_returns(self):
 
1026
        self.assertEqual(['foo\rbar\n'],
 
1027
                         osutils.split_lines('foo\rbar\n'))
 
1028
 
 
1029
 
 
1030
class TestWalkDirs(tests.TestCaseInTempDir):
 
1031
 
 
1032
    def assertExpectedBlocks(self, expected, result):
 
1033
        self.assertEqual(expected,
 
1034
                         [(dirinfo, [line[0:3] for line in block])
 
1035
                          for dirinfo, block in result])
 
1036
 
 
1037
    def test_walkdirs(self):
 
1038
        tree = [
 
1039
            '.bzr',
 
1040
            '0file',
 
1041
            '1dir/',
 
1042
            '1dir/0file',
 
1043
            '1dir/1dir/',
 
1044
            '2file'
 
1045
            ]
 
1046
        self.build_tree(tree)
 
1047
        expected_dirblocks = [
 
1048
                (('', '.'),
 
1049
                 [('0file', '0file', 'file'),
 
1050
                  ('1dir', '1dir', 'directory'),
 
1051
                  ('2file', '2file', 'file'),
 
1052
                 ]
 
1053
                ),
 
1054
                (('1dir', './1dir'),
 
1055
                 [('1dir/0file', '0file', 'file'),
 
1056
                  ('1dir/1dir', '1dir', 'directory'),
 
1057
                 ]
 
1058
                ),
 
1059
                (('1dir/1dir', './1dir/1dir'),
 
1060
                 [
 
1061
                 ]
 
1062
                ),
 
1063
            ]
 
1064
        result = []
 
1065
        found_bzrdir = False
 
1066
        for dirdetail, dirblock in osutils.walkdirs('.'):
 
1067
            if len(dirblock) and dirblock[0][1] == '.bzr':
 
1068
                # this tests the filtering of selected paths
 
1069
                found_bzrdir = True
 
1070
                del dirblock[0]
 
1071
            result.append((dirdetail, dirblock))
 
1072
 
 
1073
        self.assertTrue(found_bzrdir)
 
1074
        self.assertExpectedBlocks(expected_dirblocks, result)
 
1075
        # you can search a subdir only, with a supplied prefix.
 
1076
        result = []
 
1077
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
 
1078
            result.append(dirblock)
 
1079
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
 
1080
 
 
1081
    def test_walkdirs_os_error(self):
 
1082
        # <https://bugs.launchpad.net/bzr/+bug/338653>
 
1083
        # Pyrex readdir didn't raise useful messages if it had an error
 
1084
        # reading the directory
 
1085
        if sys.platform == 'win32':
 
1086
            raise tests.TestNotApplicable(
 
1087
                "readdir IOError not tested on win32")
 
1088
        self.requireFeature(features.not_running_as_root)
 
1089
        os.mkdir("test-unreadable")
 
1090
        os.chmod("test-unreadable", 0000)
 
1091
        # must chmod it back so that it can be removed
 
1092
        self.addCleanup(os.chmod, "test-unreadable", 0700)
 
1093
        # The error is not raised until the generator is actually evaluated.
 
1094
        # (It would be ok if it happened earlier but at the moment it
 
1095
        # doesn't.)
 
1096
        e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
 
1097
        self.assertEquals('./test-unreadable', e.filename)
 
1098
        self.assertEquals(errno.EACCES, e.errno)
 
1099
        # Ensure the message contains the file name
 
1100
        self.assertContainsRe(str(e), "\./test-unreadable")
 
1101
 
 
1102
 
 
1103
    def test_walkdirs_encoding_error(self):
 
1104
        # <https://bugs.launchpad.net/bzr/+bug/488519>
 
1105
        # walkdirs didn't raise a useful message when the filenames
 
1106
        # are not using the filesystem's encoding
 
1107
 
 
1108
        # require a bytestring based filesystem
 
1109
        self.requireFeature(tests.ByteStringNamedFilesystem)
 
1110
 
 
1111
        tree = [
 
1112
            '.bzr',
 
1113
            '0file',
 
1114
            '1dir/',
 
1115
            '1dir/0file',
 
1116
            '1dir/1dir/',
 
1117
            '1file'
 
1118
            ]
 
1119
 
 
1120
        self.build_tree(tree)
 
1121
 
 
1122
        # rename the 1file to a latin-1 filename
 
1123
        os.rename("./1file", "\xe8file")
 
1124
        if "\xe8file" not in os.listdir("."):
 
1125
            self.skip("Lack filesystem that preserves arbitrary bytes")
 
1126
 
 
1127
        self._save_platform_info()
 
1128
        win32utils.winver = None # Avoid the win32 detection code
 
1129
        osutils._fs_enc = 'UTF-8'
 
1130
 
 
1131
        # this should raise on error
 
1132
        def attempt():
 
1133
            for dirdetail, dirblock in osutils.walkdirs('.'):
 
1134
                pass
 
1135
 
 
1136
        self.assertRaises(errors.BadFilenameEncoding, attempt)
 
1137
 
 
1138
    def test__walkdirs_utf8(self):
 
1139
        tree = [
 
1140
            '.bzr',
 
1141
            '0file',
 
1142
            '1dir/',
 
1143
            '1dir/0file',
 
1144
            '1dir/1dir/',
 
1145
            '2file'
 
1146
            ]
 
1147
        self.build_tree(tree)
 
1148
        expected_dirblocks = [
 
1149
                (('', '.'),
 
1150
                 [('0file', '0file', 'file'),
 
1151
                  ('1dir', '1dir', 'directory'),
 
1152
                  ('2file', '2file', 'file'),
 
1153
                 ]
 
1154
                ),
 
1155
                (('1dir', './1dir'),
 
1156
                 [('1dir/0file', '0file', 'file'),
 
1157
                  ('1dir/1dir', '1dir', 'directory'),
 
1158
                 ]
 
1159
                ),
 
1160
                (('1dir/1dir', './1dir/1dir'),
 
1161
                 [
 
1162
                 ]
 
1163
                ),
 
1164
            ]
 
1165
        result = []
 
1166
        found_bzrdir = False
 
1167
        for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
 
1168
            if len(dirblock) and dirblock[0][1] == '.bzr':
 
1169
                # this tests the filtering of selected paths
 
1170
                found_bzrdir = True
 
1171
                del dirblock[0]
 
1172
            result.append((dirdetail, dirblock))
 
1173
 
 
1174
        self.assertTrue(found_bzrdir)
 
1175
        self.assertExpectedBlocks(expected_dirblocks, result)
 
1176
 
 
1177
        # you can search a subdir only, with a supplied prefix.
 
1178
        result = []
 
1179
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
 
1180
            result.append(dirblock)
 
1181
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
 
1182
 
 
1183
    def _filter_out_stat(self, result):
 
1184
        """Filter out the stat value from the walkdirs result"""
 
1185
        for dirdetail, dirblock in result:
 
1186
            new_dirblock = []
 
1187
            for info in dirblock:
 
1188
                # Ignore info[3] which is the stat
 
1189
                new_dirblock.append((info[0], info[1], info[2], info[4]))
 
1190
            dirblock[:] = new_dirblock
 
1191
 
 
1192
    def _save_platform_info(self):
 
1193
        self.overrideAttr(win32utils, 'winver')
 
1194
        self.overrideAttr(osutils, '_fs_enc')
 
1195
        self.overrideAttr(osutils, '_selected_dir_reader')
 
1196
 
 
1197
    def assertDirReaderIs(self, expected):
 
1198
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
 
1199
        # Force it to redetect
 
1200
        osutils._selected_dir_reader = None
 
1201
        # Nothing to list, but should still trigger the selection logic
 
1202
        self.assertEqual([(('', '.'), [])], list(osutils._walkdirs_utf8('.')))
 
1203
        self.assertIsInstance(osutils._selected_dir_reader, expected)
 
1204
 
 
1205
    def test_force_walkdirs_utf8_fs_utf8(self):
 
1206
        self.requireFeature(UTF8DirReaderFeature)
 
1207
        self._save_platform_info()
 
1208
        win32utils.winver = None # Avoid the win32 detection code
 
1209
        osutils._fs_enc = 'UTF-8'
 
1210
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1211
 
 
1212
    def test_force_walkdirs_utf8_fs_ascii(self):
 
1213
        self.requireFeature(UTF8DirReaderFeature)
 
1214
        self._save_platform_info()
 
1215
        win32utils.winver = None # Avoid the win32 detection code
 
1216
        osutils._fs_enc = 'US-ASCII'
 
1217
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1218
 
 
1219
    def test_force_walkdirs_utf8_fs_ANSI(self):
 
1220
        self.requireFeature(UTF8DirReaderFeature)
 
1221
        self._save_platform_info()
 
1222
        win32utils.winver = None # Avoid the win32 detection code
 
1223
        osutils._fs_enc = 'ANSI_X3.4-1968'
 
1224
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
 
1225
 
 
1226
    def test_force_walkdirs_utf8_fs_latin1(self):
 
1227
        self._save_platform_info()
 
1228
        win32utils.winver = None # Avoid the win32 detection code
 
1229
        osutils._fs_enc = 'latin1'
 
1230
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
1231
 
 
1232
    def test_force_walkdirs_utf8_nt(self):
 
1233
        # Disabled because the thunk of the whole walkdirs api is disabled.
 
1234
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1235
        self._save_platform_info()
 
1236
        win32utils.winver = 'Windows NT'
 
1237
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1238
        self.assertDirReaderIs(Win32ReadDir)
 
1239
 
 
1240
    def test_force_walkdirs_utf8_98(self):
 
1241
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1242
        self._save_platform_info()
 
1243
        win32utils.winver = 'Windows 98'
 
1244
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
1245
 
 
1246
    def test_unicode_walkdirs(self):
 
1247
        """Walkdirs should always return unicode paths."""
 
1248
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1249
        name0 = u'0file-\xb6'
 
1250
        name1 = u'1dir-\u062c\u0648'
 
1251
        name2 = u'2file-\u0633'
 
1252
        tree = [
 
1253
            name0,
 
1254
            name1 + '/',
 
1255
            name1 + '/' + name0,
 
1256
            name1 + '/' + name1 + '/',
 
1257
            name2,
 
1258
            ]
 
1259
        self.build_tree(tree)
 
1260
        expected_dirblocks = [
 
1261
                ((u'', u'.'),
 
1262
                 [(name0, name0, 'file', './' + name0),
 
1263
                  (name1, name1, 'directory', './' + name1),
 
1264
                  (name2, name2, 'file', './' + name2),
 
1265
                 ]
 
1266
                ),
 
1267
                ((name1, './' + name1),
 
1268
                 [(name1 + '/' + name0, name0, 'file', './' + name1
 
1269
                                                        + '/' + name0),
 
1270
                  (name1 + '/' + name1, name1, 'directory', './' + name1
 
1271
                                                            + '/' + name1),
 
1272
                 ]
 
1273
                ),
 
1274
                ((name1 + '/' + name1, './' + name1 + '/' + name1),
 
1275
                 [
 
1276
                 ]
 
1277
                ),
 
1278
            ]
 
1279
        result = list(osutils.walkdirs('.'))
 
1280
        self._filter_out_stat(result)
 
1281
        self.assertEqual(expected_dirblocks, result)
 
1282
        result = list(osutils.walkdirs(u'./'+name1, name1))
 
1283
        self._filter_out_stat(result)
 
1284
        self.assertEqual(expected_dirblocks[1:], result)
 
1285
 
 
1286
    def test_unicode__walkdirs_utf8(self):
 
1287
        """Walkdirs_utf8 should always return utf8 paths.
 
1288
 
 
1289
        The abspath portion might be in unicode or utf-8
 
1290
        """
 
1291
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1292
        name0 = u'0file-\xb6'
 
1293
        name1 = u'1dir-\u062c\u0648'
 
1294
        name2 = u'2file-\u0633'
 
1295
        tree = [
 
1296
            name0,
 
1297
            name1 + '/',
 
1298
            name1 + '/' + name0,
 
1299
            name1 + '/' + name1 + '/',
 
1300
            name2,
 
1301
            ]
 
1302
        self.build_tree(tree)
 
1303
        name0 = name0.encode('utf8')
 
1304
        name1 = name1.encode('utf8')
 
1305
        name2 = name2.encode('utf8')
 
1306
 
 
1307
        expected_dirblocks = [
 
1308
                (('', '.'),
 
1309
                 [(name0, name0, 'file', './' + name0),
 
1310
                  (name1, name1, 'directory', './' + name1),
 
1311
                  (name2, name2, 'file', './' + name2),
 
1312
                 ]
 
1313
                ),
 
1314
                ((name1, './' + name1),
 
1315
                 [(name1 + '/' + name0, name0, 'file', './' + name1
 
1316
                                                        + '/' + name0),
 
1317
                  (name1 + '/' + name1, name1, 'directory', './' + name1
 
1318
                                                            + '/' + name1),
 
1319
                 ]
 
1320
                ),
 
1321
                ((name1 + '/' + name1, './' + name1 + '/' + name1),
 
1322
                 [
 
1323
                 ]
 
1324
                ),
 
1325
            ]
 
1326
        result = []
 
1327
        # For ease in testing, if walkdirs_utf8 returns Unicode, assert that
 
1328
        # all abspaths are Unicode, and encode them back into utf8.
 
1329
        for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
 
1330
            self.assertIsInstance(dirdetail[0], str)
 
1331
            if isinstance(dirdetail[1], unicode):
 
1332
                dirdetail = (dirdetail[0], dirdetail[1].encode('utf8'))
 
1333
                dirblock = [list(info) for info in dirblock]
 
1334
                for info in dirblock:
 
1335
                    self.assertIsInstance(info[4], unicode)
 
1336
                    info[4] = info[4].encode('utf8')
 
1337
            new_dirblock = []
 
1338
            for info in dirblock:
 
1339
                self.assertIsInstance(info[0], str)
 
1340
                self.assertIsInstance(info[1], str)
 
1341
                self.assertIsInstance(info[4], str)
 
1342
                # Remove the stat information
 
1343
                new_dirblock.append((info[0], info[1], info[2], info[4]))
 
1344
            result.append((dirdetail, new_dirblock))
 
1345
        self.assertEqual(expected_dirblocks, result)
 
1346
 
 
1347
    def test__walkdirs_utf8_with_unicode_fs(self):
 
1348
        """UnicodeDirReader should be a safe fallback everywhere
 
1349
 
 
1350
        The abspath portion should be in unicode
 
1351
        """
 
1352
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1353
        # Use the unicode reader. TODO: split into driver-and-driven unit
 
1354
        # tests.
 
1355
        self._save_platform_info()
 
1356
        osutils._selected_dir_reader = osutils.UnicodeDirReader()
 
1357
        name0u = u'0file-\xb6'
 
1358
        name1u = u'1dir-\u062c\u0648'
 
1359
        name2u = u'2file-\u0633'
 
1360
        tree = [
 
1361
            name0u,
 
1362
            name1u + '/',
 
1363
            name1u + '/' + name0u,
 
1364
            name1u + '/' + name1u + '/',
 
1365
            name2u,
 
1366
            ]
 
1367
        self.build_tree(tree)
 
1368
        name0 = name0u.encode('utf8')
 
1369
        name1 = name1u.encode('utf8')
 
1370
        name2 = name2u.encode('utf8')
 
1371
 
 
1372
        # All of the abspaths should be in unicode, all of the relative paths
 
1373
        # should be in utf8
 
1374
        expected_dirblocks = [
 
1375
                (('', '.'),
 
1376
                 [(name0, name0, 'file', './' + name0u),
 
1377
                  (name1, name1, 'directory', './' + name1u),
 
1378
                  (name2, name2, 'file', './' + name2u),
 
1379
                 ]
 
1380
                ),
 
1381
                ((name1, './' + name1u),
 
1382
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1383
                                                        + '/' + name0u),
 
1384
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1385
                                                            + '/' + name1u),
 
1386
                 ]
 
1387
                ),
 
1388
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1389
                 [
 
1390
                 ]
 
1391
                ),
 
1392
            ]
 
1393
        result = list(osutils._walkdirs_utf8('.'))
 
1394
        self._filter_out_stat(result)
 
1395
        self.assertEqual(expected_dirblocks, result)
 
1396
 
 
1397
    def test__walkdirs_utf8_win32readdir(self):
 
1398
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1399
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1400
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1401
        self._save_platform_info()
 
1402
        osutils._selected_dir_reader = Win32ReadDir()
 
1403
        name0u = u'0file-\xb6'
 
1404
        name1u = u'1dir-\u062c\u0648'
 
1405
        name2u = u'2file-\u0633'
 
1406
        tree = [
 
1407
            name0u,
 
1408
            name1u + '/',
 
1409
            name1u + '/' + name0u,
 
1410
            name1u + '/' + name1u + '/',
 
1411
            name2u,
 
1412
            ]
 
1413
        self.build_tree(tree)
 
1414
        name0 = name0u.encode('utf8')
 
1415
        name1 = name1u.encode('utf8')
 
1416
        name2 = name2u.encode('utf8')
 
1417
 
 
1418
        # All of the abspaths should be in unicode, all of the relative paths
 
1419
        # should be in utf8
 
1420
        expected_dirblocks = [
 
1421
                (('', '.'),
 
1422
                 [(name0, name0, 'file', './' + name0u),
 
1423
                  (name1, name1, 'directory', './' + name1u),
 
1424
                  (name2, name2, 'file', './' + name2u),
 
1425
                 ]
 
1426
                ),
 
1427
                ((name1, './' + name1u),
 
1428
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1429
                                                        + '/' + name0u),
 
1430
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1431
                                                            + '/' + name1u),
 
1432
                 ]
 
1433
                ),
 
1434
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1435
                 [
 
1436
                 ]
 
1437
                ),
 
1438
            ]
 
1439
        result = list(osutils._walkdirs_utf8(u'.'))
 
1440
        self._filter_out_stat(result)
 
1441
        self.assertEqual(expected_dirblocks, result)
 
1442
 
 
1443
    def assertStatIsCorrect(self, path, win32stat):
 
1444
        os_stat = os.stat(path)
 
1445
        self.assertEqual(os_stat.st_size, win32stat.st_size)
 
1446
        self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
 
1447
        self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
 
1448
        self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
 
1449
        self.assertEqual(os_stat.st_dev, win32stat.st_dev)
 
1450
        self.assertEqual(os_stat.st_ino, win32stat.st_ino)
 
1451
        self.assertEqual(os_stat.st_mode, win32stat.st_mode)
 
1452
 
 
1453
    def test__walkdirs_utf_win32_find_file_stat_file(self):
 
1454
        """make sure our Stat values are valid"""
 
1455
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1456
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1457
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1458
        name0u = u'0file-\xb6'
 
1459
        name0 = name0u.encode('utf8')
 
1460
        self.build_tree([name0u])
 
1461
        # I hate to sleep() here, but I'm trying to make the ctime different
 
1462
        # from the mtime
 
1463
        time.sleep(2)
 
1464
        f = open(name0u, 'ab')
 
1465
        try:
 
1466
            f.write('just a small update')
 
1467
        finally:
 
1468
            f.close()
 
1469
 
 
1470
        result = Win32ReadDir().read_dir('', u'.')
 
1471
        entry = result[0]
 
1472
        self.assertEqual((name0, name0, 'file'), entry[:3])
 
1473
        self.assertEqual(u'./' + name0u, entry[4])
 
1474
        self.assertStatIsCorrect(entry[4], entry[3])
 
1475
        self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
 
1476
 
 
1477
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
 
1478
        """make sure our Stat values are valid"""
 
1479
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1480
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1481
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1482
        name0u = u'0dir-\u062c\u0648'
 
1483
        name0 = name0u.encode('utf8')
 
1484
        self.build_tree([name0u + '/'])
 
1485
 
 
1486
        result = Win32ReadDir().read_dir('', u'.')
 
1487
        entry = result[0]
 
1488
        self.assertEqual((name0, name0, 'directory'), entry[:3])
 
1489
        self.assertEqual(u'./' + name0u, entry[4])
 
1490
        self.assertStatIsCorrect(entry[4], entry[3])
 
1491
 
 
1492
    def assertPathCompare(self, path_less, path_greater):
 
1493
        """check that path_less and path_greater compare correctly."""
 
1494
        self.assertEqual(0, osutils.compare_paths_prefix_order(
 
1495
            path_less, path_less))
 
1496
        self.assertEqual(0, osutils.compare_paths_prefix_order(
 
1497
            path_greater, path_greater))
 
1498
        self.assertEqual(-1, osutils.compare_paths_prefix_order(
 
1499
            path_less, path_greater))
 
1500
        self.assertEqual(1, osutils.compare_paths_prefix_order(
 
1501
            path_greater, path_less))
 
1502
 
 
1503
    def test_compare_paths_prefix_order(self):
 
1504
        # root before all else
 
1505
        self.assertPathCompare("/", "/a")
 
1506
        # alpha within a dir
 
1507
        self.assertPathCompare("/a", "/b")
 
1508
        self.assertPathCompare("/b", "/z")
 
1509
        # high dirs before lower.
 
1510
        self.assertPathCompare("/z", "/a/a")
 
1511
        # except if the deeper dir should be output first
 
1512
        self.assertPathCompare("/a/b/c", "/d/g")
 
1513
        # lexical betwen dirs of the same height
 
1514
        self.assertPathCompare("/a/z", "/z/z")
 
1515
        self.assertPathCompare("/a/c/z", "/a/d/e")
 
1516
 
 
1517
        # this should also be consistent for no leading / paths
 
1518
        # root before all else
 
1519
        self.assertPathCompare("", "a")
 
1520
        # alpha within a dir
 
1521
        self.assertPathCompare("a", "b")
 
1522
        self.assertPathCompare("b", "z")
 
1523
        # high dirs before lower.
 
1524
        self.assertPathCompare("z", "a/a")
 
1525
        # except if the deeper dir should be output first
 
1526
        self.assertPathCompare("a/b/c", "d/g")
 
1527
        # lexical betwen dirs of the same height
 
1528
        self.assertPathCompare("a/z", "z/z")
 
1529
        self.assertPathCompare("a/c/z", "a/d/e")
 
1530
 
 
1531
    def test_path_prefix_sorting(self):
 
1532
        """Doing a sort on path prefix should match our sample data."""
 
1533
        original_paths = [
 
1534
            'a',
 
1535
            'a/b',
 
1536
            'a/b/c',
 
1537
            'b',
 
1538
            'b/c',
 
1539
            'd',
 
1540
            'd/e',
 
1541
            'd/e/f',
 
1542
            'd/f',
 
1543
            'd/g',
 
1544
            'g',
 
1545
            ]
 
1546
 
 
1547
        dir_sorted_paths = [
 
1548
            'a',
 
1549
            'b',
 
1550
            'd',
 
1551
            'g',
 
1552
            'a/b',
 
1553
            'a/b/c',
 
1554
            'b/c',
 
1555
            'd/e',
 
1556
            'd/f',
 
1557
            'd/g',
 
1558
            'd/e/f',
 
1559
            ]
 
1560
 
 
1561
        self.assertEqual(
 
1562
            dir_sorted_paths,
 
1563
            sorted(original_paths, key=osutils.path_prefix_key))
 
1564
        # using the comparison routine shoudl work too:
 
1565
        self.assertEqual(
 
1566
            dir_sorted_paths,
 
1567
            sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
 
1568
 
 
1569
 
 
1570
class TestCopyTree(tests.TestCaseInTempDir):
 
1571
 
 
1572
    def test_copy_basic_tree(self):
 
1573
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
 
1574
        osutils.copy_tree('source', 'target')
 
1575
        self.assertEqual(['a', 'b'], sorted(os.listdir('target')))
 
1576
        self.assertEqual(['c'], os.listdir('target/b'))
 
1577
 
 
1578
    def test_copy_tree_target_exists(self):
 
1579
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c',
 
1580
                         'target/'])
 
1581
        osutils.copy_tree('source', 'target')
 
1582
        self.assertEqual(['a', 'b'], sorted(os.listdir('target')))
 
1583
        self.assertEqual(['c'], os.listdir('target/b'))
 
1584
 
 
1585
    def test_copy_tree_symlinks(self):
 
1586
        self.requireFeature(tests.SymlinkFeature)
 
1587
        self.build_tree(['source/'])
 
1588
        os.symlink('a/generic/path', 'source/lnk')
 
1589
        osutils.copy_tree('source', 'target')
 
1590
        self.assertEqual(['lnk'], os.listdir('target'))
 
1591
        self.assertEqual('a/generic/path', os.readlink('target/lnk'))
 
1592
 
 
1593
    def test_copy_tree_handlers(self):
 
1594
        processed_files = []
 
1595
        processed_links = []
 
1596
        def file_handler(from_path, to_path):
 
1597
            processed_files.append(('f', from_path, to_path))
 
1598
        def dir_handler(from_path, to_path):
 
1599
            processed_files.append(('d', from_path, to_path))
 
1600
        def link_handler(from_path, to_path):
 
1601
            processed_links.append((from_path, to_path))
 
1602
        handlers = {'file':file_handler,
 
1603
                    'directory':dir_handler,
 
1604
                    'symlink':link_handler,
 
1605
                   }
 
1606
 
 
1607
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
 
1608
        if osutils.has_symlinks():
 
1609
            os.symlink('a/generic/path', 'source/lnk')
 
1610
        osutils.copy_tree('source', 'target', handlers=handlers)
 
1611
 
 
1612
        self.assertEqual([('d', 'source', 'target'),
 
1613
                          ('f', 'source/a', 'target/a'),
 
1614
                          ('d', 'source/b', 'target/b'),
 
1615
                          ('f', 'source/b/c', 'target/b/c'),
 
1616
                         ], processed_files)
 
1617
        self.assertPathDoesNotExist('target')
 
1618
        if osutils.has_symlinks():
 
1619
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
 
1620
 
 
1621
 
 
1622
class TestSetUnsetEnv(tests.TestCase):
 
1623
    """Test updating the environment"""
 
1624
 
 
1625
    def setUp(self):
 
1626
        super(TestSetUnsetEnv, self).setUp()
 
1627
 
 
1628
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'),
 
1629
                         'Environment was not cleaned up properly.'
 
1630
                         ' Variable BZR_TEST_ENV_VAR should not exist.')
 
1631
        def cleanup():
 
1632
            if 'BZR_TEST_ENV_VAR' in os.environ:
 
1633
                del os.environ['BZR_TEST_ENV_VAR']
 
1634
        self.addCleanup(cleanup)
 
1635
 
 
1636
    def test_set(self):
 
1637
        """Test that we can set an env variable"""
 
1638
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
 
1639
        self.assertEqual(None, old)
 
1640
        self.assertEqual('foo', os.environ.get('BZR_TEST_ENV_VAR'))
 
1641
 
 
1642
    def test_double_set(self):
 
1643
        """Test that we get the old value out"""
 
1644
        osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
 
1645
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'bar')
 
1646
        self.assertEqual('foo', old)
 
1647
        self.assertEqual('bar', os.environ.get('BZR_TEST_ENV_VAR'))
 
1648
 
 
1649
    def test_unicode(self):
 
1650
        """Environment can only contain plain strings
 
1651
 
 
1652
        So Unicode strings must be encoded.
 
1653
        """
 
1654
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
1655
        if uni_val is None:
 
1656
            raise tests.TestSkipped(
 
1657
                'Cannot find a unicode character that works in encoding %s'
 
1658
                % (osutils.get_user_encoding(),))
 
1659
 
 
1660
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
 
1661
        self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
 
1662
 
 
1663
    def test_unset(self):
 
1664
        """Test that passing None will remove the env var"""
 
1665
        osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
 
1666
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
 
1667
        self.assertEqual('foo', old)
 
1668
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
 
1669
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
 
1670
 
 
1671
 
 
1672
class TestSizeShaFile(tests.TestCaseInTempDir):
 
1673
 
 
1674
    def test_sha_empty(self):
 
1675
        self.build_tree_contents([('foo', '')])
 
1676
        expected_sha = osutils.sha_string('')
 
1677
        f = open('foo')
 
1678
        self.addCleanup(f.close)
 
1679
        size, sha = osutils.size_sha_file(f)
 
1680
        self.assertEqual(0, size)
 
1681
        self.assertEqual(expected_sha, sha)
 
1682
 
 
1683
    def test_sha_mixed_endings(self):
 
1684
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1685
        self.build_tree_contents([('foo', text)])
 
1686
        expected_sha = osutils.sha_string(text)
 
1687
        f = open('foo', 'rb')
 
1688
        self.addCleanup(f.close)
 
1689
        size, sha = osutils.size_sha_file(f)
 
1690
        self.assertEqual(38, size)
 
1691
        self.assertEqual(expected_sha, sha)
 
1692
 
 
1693
 
 
1694
class TestShaFileByName(tests.TestCaseInTempDir):
 
1695
 
 
1696
    def test_sha_empty(self):
 
1697
        self.build_tree_contents([('foo', '')])
 
1698
        expected_sha = osutils.sha_string('')
 
1699
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1700
 
 
1701
    def test_sha_mixed_endings(self):
 
1702
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1703
        self.build_tree_contents([('foo', text)])
 
1704
        expected_sha = osutils.sha_string(text)
 
1705
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1706
 
 
1707
 
 
1708
class TestResourceLoading(tests.TestCaseInTempDir):
 
1709
 
 
1710
    def test_resource_string(self):
 
1711
        # test resource in bzrlib
 
1712
        text = osutils.resource_string('bzrlib', 'debug.py')
 
1713
        self.assertContainsRe(text, "debug_flags = set()")
 
1714
        # test resource under bzrlib
 
1715
        text = osutils.resource_string('bzrlib.ui', 'text.py')
 
1716
        self.assertContainsRe(text, "class TextUIFactory")
 
1717
        # test unsupported package
 
1718
        self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
 
1719
            'yyy.xx')
 
1720
        # test unknown resource
 
1721
        self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
 
1722
 
 
1723
 
 
1724
class TestReCompile(tests.TestCase):
 
1725
 
 
1726
    def _deprecated_re_compile_checked(self, *args, **kwargs):
 
1727
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
 
1728
            osutils.re_compile_checked, *args, **kwargs)
 
1729
 
 
1730
    def test_re_compile_checked(self):
 
1731
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
 
1732
        self.assertTrue(r.match('aaaa'))
 
1733
        self.assertTrue(r.match('aAaA'))
 
1734
 
 
1735
    def test_re_compile_checked_error(self):
 
1736
        # like https://bugs.launchpad.net/bzr/+bug/251352
 
1737
 
 
1738
        # Due to possible test isolation error, re.compile is not lazy at
 
1739
        # this point. We re-install lazy compile.
 
1740
        lazy_regex.install_lazy_compile()
 
1741
        err = self.assertRaises(
 
1742
            errors.BzrCommandError,
 
1743
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1744
        self.assertEqual(
 
1745
            'Invalid regular expression in test case: '
 
1746
            '"*" nothing to repeat',
 
1747
            str(err))
 
1748
 
 
1749
 
 
1750
class TestDirReader(tests.TestCaseInTempDir):
 
1751
 
 
1752
    scenarios = dir_reader_scenarios()
 
1753
 
 
1754
    # Set by load_tests
 
1755
    _dir_reader_class = None
 
1756
    _native_to_unicode = None
 
1757
 
 
1758
    def setUp(self):
 
1759
        tests.TestCaseInTempDir.setUp(self)
 
1760
        self.overrideAttr(osutils,
 
1761
                          '_selected_dir_reader', self._dir_reader_class())
 
1762
 
 
1763
    def _get_ascii_tree(self):
 
1764
        tree = [
 
1765
            '0file',
 
1766
            '1dir/',
 
1767
            '1dir/0file',
 
1768
            '1dir/1dir/',
 
1769
            '2file'
 
1770
            ]
 
1771
        expected_dirblocks = [
 
1772
                (('', '.'),
 
1773
                 [('0file', '0file', 'file'),
 
1774
                  ('1dir', '1dir', 'directory'),
 
1775
                  ('2file', '2file', 'file'),
 
1776
                 ]
 
1777
                ),
 
1778
                (('1dir', './1dir'),
 
1779
                 [('1dir/0file', '0file', 'file'),
 
1780
                  ('1dir/1dir', '1dir', 'directory'),
 
1781
                 ]
 
1782
                ),
 
1783
                (('1dir/1dir', './1dir/1dir'),
 
1784
                 [
 
1785
                 ]
 
1786
                ),
 
1787
            ]
 
1788
        return tree, expected_dirblocks
 
1789
 
 
1790
    def test_walk_cur_dir(self):
 
1791
        tree, expected_dirblocks = self._get_ascii_tree()
 
1792
        self.build_tree(tree)
 
1793
        result = list(osutils._walkdirs_utf8('.'))
 
1794
        # Filter out stat and abspath
 
1795
        self.assertEqual(expected_dirblocks,
 
1796
                         [(dirinfo, [line[0:3] for line in block])
 
1797
                          for dirinfo, block in result])
 
1798
 
 
1799
    def test_walk_sub_dir(self):
 
1800
        tree, expected_dirblocks = self._get_ascii_tree()
 
1801
        self.build_tree(tree)
 
1802
        # you can search a subdir only, with a supplied prefix.
 
1803
        result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
 
1804
        # Filter out stat and abspath
 
1805
        self.assertEqual(expected_dirblocks[1:],
 
1806
                         [(dirinfo, [line[0:3] for line in block])
 
1807
                          for dirinfo, block in result])
 
1808
 
 
1809
    def _get_unicode_tree(self):
 
1810
        name0u = u'0file-\xb6'
 
1811
        name1u = u'1dir-\u062c\u0648'
 
1812
        name2u = u'2file-\u0633'
 
1813
        tree = [
 
1814
            name0u,
 
1815
            name1u + '/',
 
1816
            name1u + '/' + name0u,
 
1817
            name1u + '/' + name1u + '/',
 
1818
            name2u,
 
1819
            ]
 
1820
        name0 = name0u.encode('UTF-8')
 
1821
        name1 = name1u.encode('UTF-8')
 
1822
        name2 = name2u.encode('UTF-8')
 
1823
        expected_dirblocks = [
 
1824
                (('', '.'),
 
1825
                 [(name0, name0, 'file', './' + name0u),
 
1826
                  (name1, name1, 'directory', './' + name1u),
 
1827
                  (name2, name2, 'file', './' + name2u),
 
1828
                 ]
 
1829
                ),
 
1830
                ((name1, './' + name1u),
 
1831
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1832
                                                        + '/' + name0u),
 
1833
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1834
                                                            + '/' + name1u),
 
1835
                 ]
 
1836
                ),
 
1837
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1838
                 [
 
1839
                 ]
 
1840
                ),
 
1841
            ]
 
1842
        return tree, expected_dirblocks
 
1843
 
 
1844
    def _filter_out(self, raw_dirblocks):
 
1845
        """Filter out a walkdirs_utf8 result.
 
1846
 
 
1847
        stat field is removed, all native paths are converted to unicode
 
1848
        """
 
1849
        filtered_dirblocks = []
 
1850
        for dirinfo, block in raw_dirblocks:
 
1851
            dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
 
1852
            details = []
 
1853
            for line in block:
 
1854
                details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
 
1855
            filtered_dirblocks.append((dirinfo, details))
 
1856
        return filtered_dirblocks
 
1857
 
 
1858
    def test_walk_unicode_tree(self):
 
1859
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1860
        tree, expected_dirblocks = self._get_unicode_tree()
 
1861
        self.build_tree(tree)
 
1862
        result = list(osutils._walkdirs_utf8('.'))
 
1863
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1864
 
 
1865
    def test_symlink(self):
 
1866
        self.requireFeature(tests.SymlinkFeature)
 
1867
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1868
        target = u'target\N{Euro Sign}'
 
1869
        link_name = u'l\N{Euro Sign}nk'
 
1870
        os.symlink(target, link_name)
 
1871
        target_utf8 = target.encode('UTF-8')
 
1872
        link_name_utf8 = link_name.encode('UTF-8')
 
1873
        expected_dirblocks = [
 
1874
                (('', '.'),
 
1875
                 [(link_name_utf8, link_name_utf8,
 
1876
                   'symlink', './' + link_name),],
 
1877
                 )]
 
1878
        result = list(osutils._walkdirs_utf8('.'))
 
1879
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1880
 
 
1881
 
 
1882
class TestReadLink(tests.TestCaseInTempDir):
 
1883
    """Exposes os.readlink() problems and the osutils solution.
 
1884
 
 
1885
    The only guarantee offered by os.readlink(), starting with 2.6, is that a
 
1886
    unicode string will be returned if a unicode string is passed.
 
1887
 
 
1888
    But prior python versions failed to properly encode the passed unicode
 
1889
    string.
 
1890
    """
 
1891
    _test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
 
1892
 
 
1893
    def setUp(self):
 
1894
        super(tests.TestCaseInTempDir, self).setUp()
 
1895
        self.link = u'l\N{Euro Sign}ink'
 
1896
        self.target = u'targe\N{Euro Sign}t'
 
1897
        os.symlink(self.target, self.link)
 
1898
 
 
1899
    def test_os_readlink_link_encoding(self):
 
1900
        if sys.version_info < (2, 6):
 
1901
            self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
 
1902
        else:
 
1903
            self.assertEquals(self.target,  os.readlink(self.link))
 
1904
 
 
1905
    def test_os_readlink_link_decoding(self):
 
1906
        self.assertEquals(self.target.encode(osutils._fs_enc),
 
1907
                          os.readlink(self.link.encode(osutils._fs_enc)))
 
1908
 
 
1909
 
 
1910
class TestConcurrency(tests.TestCase):
 
1911
 
 
1912
    def setUp(self):
 
1913
        super(TestConcurrency, self).setUp()
 
1914
        self.overrideAttr(osutils, '_cached_local_concurrency')
 
1915
 
 
1916
    def test_local_concurrency(self):
 
1917
        concurrency = osutils.local_concurrency()
 
1918
        self.assertIsInstance(concurrency, int)
 
1919
 
 
1920
    def test_local_concurrency_environment_variable(self):
 
1921
        self.overrideEnv('BZR_CONCURRENCY', '2')
 
1922
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
 
1923
        self.overrideEnv('BZR_CONCURRENCY', '3')
 
1924
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
 
1925
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
 
1926
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
 
1927
 
 
1928
    def test_option_concurrency(self):
 
1929
        self.overrideEnv('BZR_CONCURRENCY', '1')
 
1930
        self.run_bzr('rocks --concurrency 42')
 
1931
        # Command line overrides environment variable
 
1932
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
 
1933
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
 
1934
 
 
1935
 
 
1936
class TestFailedToLoadExtension(tests.TestCase):
 
1937
 
 
1938
    def _try_loading(self):
 
1939
        try:
 
1940
            import bzrlib._fictional_extension_py
 
1941
        except ImportError, e:
 
1942
            osutils.failed_to_load_extension(e)
 
1943
            return True
 
1944
 
 
1945
    def setUp(self):
 
1946
        super(TestFailedToLoadExtension, self).setUp()
 
1947
        self.overrideAttr(osutils, '_extension_load_failures', [])
 
1948
 
 
1949
    def test_failure_to_load(self):
 
1950
        self._try_loading()
 
1951
        self.assertLength(1, osutils._extension_load_failures)
 
1952
        self.assertEquals(osutils._extension_load_failures[0],
 
1953
            "No module named _fictional_extension_py")
 
1954
 
 
1955
    def test_report_extension_load_failures_no_warning(self):
 
1956
        self.assertTrue(self._try_loading())
 
1957
        warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
 
1958
        # it used to give a Python warning; it no longer does
 
1959
        self.assertLength(0, warnings)
 
1960
 
 
1961
    def test_report_extension_load_failures_message(self):
 
1962
        log = StringIO()
 
1963
        trace.push_log_file(log)
 
1964
        self.assertTrue(self._try_loading())
 
1965
        osutils.report_extension_load_failures()
 
1966
        self.assertContainsRe(
 
1967
            log.getvalue(),
 
1968
            r"bzr: warning: some compiled extensions could not be loaded; "
 
1969
            "see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
 
1970
            )
 
1971
 
 
1972
 
 
1973
class TestTerminalWidth(tests.TestCase):
 
1974
 
 
1975
    def setUp(self):
 
1976
        tests.TestCase.setUp(self)
 
1977
        self._orig_terminal_size_state = osutils._terminal_size_state
 
1978
        self._orig_first_terminal_size = osutils._first_terminal_size
 
1979
        self.addCleanup(self.restore_osutils_globals)
 
1980
        osutils._terminal_size_state = 'no_data'
 
1981
        osutils._first_terminal_size = None
 
1982
 
 
1983
    def restore_osutils_globals(self):
 
1984
        osutils._terminal_size_state = self._orig_terminal_size_state
 
1985
        osutils._first_terminal_size = self._orig_first_terminal_size
 
1986
 
 
1987
    def replace_stdout(self, new):
 
1988
        self.overrideAttr(sys, 'stdout', new)
 
1989
 
 
1990
    def replace__terminal_size(self, new):
 
1991
        self.overrideAttr(osutils, '_terminal_size', new)
 
1992
 
 
1993
    def set_fake_tty(self):
 
1994
 
 
1995
        class I_am_a_tty(object):
 
1996
            def isatty(self):
 
1997
                return True
 
1998
 
 
1999
        self.replace_stdout(I_am_a_tty())
 
2000
 
 
2001
    def test_default_values(self):
 
2002
        self.assertEqual(80, osutils.default_terminal_width)
 
2003
 
 
2004
    def test_defaults_to_BZR_COLUMNS(self):
 
2005
        # BZR_COLUMNS is set by the test framework
 
2006
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
 
2007
        self.overrideEnv('BZR_COLUMNS', '12')
 
2008
        self.assertEqual(12, osutils.terminal_width())
 
2009
 
 
2010
    def test_BZR_COLUMNS_0_no_limit(self):
 
2011
        self.overrideEnv('BZR_COLUMNS', '0')
 
2012
        self.assertEqual(None, osutils.terminal_width())
 
2013
 
 
2014
    def test_falls_back_to_COLUMNS(self):
 
2015
        self.overrideEnv('BZR_COLUMNS', None)
 
2016
        self.assertNotEqual('42', os.environ['COLUMNS'])
 
2017
        self.set_fake_tty()
 
2018
        self.overrideEnv('COLUMNS', '42')
 
2019
        self.assertEqual(42, osutils.terminal_width())
 
2020
 
 
2021
    def test_tty_default_without_columns(self):
 
2022
        self.overrideEnv('BZR_COLUMNS', None)
 
2023
        self.overrideEnv('COLUMNS', None)
 
2024
 
 
2025
        def terminal_size(w, h):
 
2026
            return 42, 42
 
2027
 
 
2028
        self.set_fake_tty()
 
2029
        # We need to override the osutils definition as it depends on the
 
2030
        # running environment that we can't control (PQM running without a
 
2031
        # controlling terminal is one example).
 
2032
        self.replace__terminal_size(terminal_size)
 
2033
        self.assertEqual(42, osutils.terminal_width())
 
2034
 
 
2035
    def test_non_tty_default_without_columns(self):
 
2036
        self.overrideEnv('BZR_COLUMNS', None)
 
2037
        self.overrideEnv('COLUMNS', None)
 
2038
        self.replace_stdout(None)
 
2039
        self.assertEqual(None, osutils.terminal_width())
 
2040
 
 
2041
    def test_no_TIOCGWINSZ(self):
 
2042
        self.requireFeature(term_ios_feature)
 
2043
        termios = term_ios_feature.module
 
2044
        # bug 63539 is about a termios without TIOCGWINSZ attribute
 
2045
        try:
 
2046
            orig = termios.TIOCGWINSZ
 
2047
        except AttributeError:
 
2048
            # We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
 
2049
            pass
 
2050
        else:
 
2051
            self.overrideAttr(termios, 'TIOCGWINSZ')
 
2052
            del termios.TIOCGWINSZ
 
2053
        self.overrideEnv('BZR_COLUMNS', None)
 
2054
        self.overrideEnv('COLUMNS', None)
 
2055
        # Whatever the result is, if we don't raise an exception, it's ok.
 
2056
        osutils.terminal_width()
 
2057
 
 
2058
class TestCreationOps(tests.TestCaseInTempDir):
 
2059
    _test_needs_features = [features.chown_feature]
 
2060
 
 
2061
    def setUp(self):
 
2062
        tests.TestCaseInTempDir.setUp(self)
 
2063
        self.overrideAttr(os, 'chown', self._dummy_chown)
 
2064
 
 
2065
        # params set by call to _dummy_chown
 
2066
        self.path = self.uid = self.gid = None
 
2067
 
 
2068
    def _dummy_chown(self, path, uid, gid):
 
2069
        self.path, self.uid, self.gid = path, uid, gid
 
2070
 
 
2071
    def test_copy_ownership_from_path(self):
 
2072
        """copy_ownership_from_path test with specified src."""
 
2073
        ownsrc = '/'
 
2074
        f = open('test_file', 'wt')
 
2075
        osutils.copy_ownership_from_path('test_file', ownsrc)
 
2076
 
 
2077
        s = os.stat(ownsrc)
 
2078
        self.assertEquals(self.path, 'test_file')
 
2079
        self.assertEquals(self.uid, s.st_uid)
 
2080
        self.assertEquals(self.gid, s.st_gid)
 
2081
 
 
2082
    def test_copy_ownership_nonesrc(self):
 
2083
        """copy_ownership_from_path test with src=None."""
 
2084
        f = open('test_file', 'wt')
 
2085
        # should use parent dir for permissions
 
2086
        osutils.copy_ownership_from_path('test_file')
 
2087
 
 
2088
        s = os.stat('..')
 
2089
        self.assertEquals(self.path, 'test_file')
 
2090
        self.assertEquals(self.uid, s.st_uid)
 
2091
        self.assertEquals(self.gid, s.st_gid)
 
2092
 
 
2093
class TestGetuserUnicode(tests.TestCase):
 
2094
 
 
2095
    def test_ascii_user(self):
 
2096
        self.overrideEnv('LOGNAME', 'jrandom')
 
2097
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
 
2098
 
 
2099
    def test_unicode_user(self):
 
2100
        ue = osutils.get_user_encoding()
 
2101
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
2102
        if uni_val is None:
 
2103
            raise tests.TestSkipped(
 
2104
                'Cannot find a unicode character that works in encoding %s'
 
2105
                % (osutils.get_user_encoding(),))
 
2106
        uni_username = u'jrandom' + uni_val
 
2107
        encoded_username = uni_username.encode(ue)
 
2108
        self.overrideEnv('LOGNAME', encoded_username)
 
2109
        self.assertEqual(uni_username, osutils.getuser_unicode())
 
2110
        self.overrideEnv('LOGNAME', u'jrandom\xb6'.encode(ue))
 
2111
        self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
 
2112
 
 
2113
class TestBackupNames(tests.TestCase):
 
2114
 
 
2115
    def setUp(self):
 
2116
        super(TestBackupNames, self).setUp()
 
2117
        self.backups = []
 
2118
 
 
2119
    def backup_exists(self, name):
 
2120
        return name in self.backups
 
2121
 
 
2122
    def available_backup_name(self, name):
 
2123
        backup_name = osutils.available_backup_name(name, self.backup_exists)
 
2124
        self.backups.append(backup_name)
 
2125
        return backup_name
 
2126
 
 
2127
    def assertBackupName(self, expected, name):
 
2128
        self.assertEqual(expected, self.available_backup_name(name))
 
2129
 
 
2130
    def test_empty(self):
 
2131
        self.assertBackupName('file.~1~', 'file')
 
2132
 
 
2133
    def test_existing(self):
 
2134
        self.available_backup_name('file')
 
2135
        self.available_backup_name('file')
 
2136
        self.assertBackupName('file.~3~', 'file')
 
2137
        # Empty slots are found, this is not a strict requirement and may be
 
2138
        # revisited if we test against all implementations.
 
2139
        self.backups.remove('file.~2~')
 
2140
        self.assertBackupName('file.~2~', 'file')
 
2141
 
 
2142
 
 
2143
class TestFindExecutableInPath(tests.TestCase):
 
2144
 
 
2145
    def test_windows(self):
 
2146
        if sys.platform != 'win32':
 
2147
            raise tests.TestSkipped('test requires win32')
 
2148
        self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
 
2149
        self.assertTrue(
 
2150
            osutils.find_executable_on_path('explorer.exe') is not None)
 
2151
        self.assertTrue(
 
2152
            osutils.find_executable_on_path('EXPLORER.EXE') is not None)
 
2153
        self.assertTrue(
 
2154
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2155
        self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
 
2156
 
 
2157
    def test_other(self):
 
2158
        if sys.platform == 'win32':
 
2159
            raise tests.TestSkipped('test requires non-win32')
 
2160
        self.assertTrue(osutils.find_executable_on_path('sh') is not None)
 
2161
        self.assertTrue(
 
2162
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)