~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: Martin Pool
  • Date: 2005-07-28 11:56:24 UTC
  • Revision ID: mbp@sourcefrog.net-20050728115624-93c11c2b1e399023
- note changes to command line parsing

Show diffs side-by-side

added added

removed removed

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