← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: Patch Queue Manager
  • Date: 2015-10-05 13:45:00 UTC
  • mfrom: (6603.3.1 bts794146)
  • Revision ID: pqm@pqm.ubuntu.com-20151005134500-v244rho557tv0ukd
(vila) Resolve Bug #1480015: Test failure: hexify removed from paramiko
 (Andrew Starr-Bochicchio) (Andrew Starr-Bochicchio)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_osutils.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2015 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
20
20
import errno
21
21
import os
22
22
import re
 
23
import select
23
24
import socket
24
 
import stat
25
25
import sys
 
26
import tempfile
26
27
import time
27
28
 
28
29
from bzrlib import (
29
30
    errors,
 
31
    lazy_regex,
30
32
    osutils,
 
33
    symbol_versioning,
31
34
    tests,
 
35
    trace,
32
36
    win32utils,
33
37
    )
34
 
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
35
 
from bzrlib.osutils import (
36
 
        canonical_relpath,
37
 
        )
38
38
from bzrlib.tests import (
39
 
        Feature,
40
 
        probe_unicode_in_user_encoding,
41
 
        StringIOWrapper,
42
 
        SymlinkFeature,
43
 
        CaseInsCasePresFilenameFeature,
44
 
        TestCase,
45
 
        TestCaseInTempDir,
46
 
        TestSkipped,
47
 
        )
48
 
from bzrlib.tests.file_utils import (
49
 
    FakeReadFile,
 
39
    features,
 
40
    file_utils,
 
41
    test__walkdirs_win32,
50
42
    )
51
 
from bzrlib.tests.test__walkdirs_win32 import Win32ReadDirFeature
52
 
 
53
 
 
54
 
class _UTF8DirReaderFeature(Feature):
 
43
from bzrlib.tests.scenarios import load_tests_apply_scenarios
 
44
 
 
45
 
 
46
class _UTF8DirReaderFeature(features.Feature):
55
47
 
56
48
    def _probe(self):
57
49
        try:
64
56
    def feature_name(self):
65
57
        return 'bzrlib._readdir_pyx'
66
58
 
67
 
UTF8DirReaderFeature = _UTF8DirReaderFeature()
68
 
 
69
 
 
70
 
class TestOSUtils(TestCaseInTempDir):
 
59
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
 
60
 
 
61
term_ios_feature = features.ModuleAvailableFeature('termios')
 
62
 
 
63
 
 
64
def _already_unicode(s):
 
65
    return s
 
66
 
 
67
 
 
68
def _utf8_to_unicode(s):
 
69
    return s.decode('UTF-8')
 
70
 
 
71
 
 
72
def dir_reader_scenarios():
 
73
    # For each dir reader we define:
 
74
 
 
75
    # - native_to_unicode: a function converting the native_abspath as returned
 
76
    #   by DirReader.read_dir to its unicode representation
 
77
 
 
78
    # UnicodeDirReader is the fallback, it should be tested on all platforms.
 
79
    scenarios = [('unicode',
 
80
                  dict(_dir_reader_class=osutils.UnicodeDirReader,
 
81
                       _native_to_unicode=_already_unicode))]
 
82
    # Some DirReaders are platform specific and even there they may not be
 
83
    # available.
 
84
    if UTF8DirReaderFeature.available():
 
85
        from bzrlib import _readdir_pyx
 
86
        scenarios.append(('utf8',
 
87
                          dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
 
88
                               _native_to_unicode=_utf8_to_unicode)))
 
89
 
 
90
    if test__walkdirs_win32.win32_readdir_feature.available():
 
91
        try:
 
92
            from bzrlib import _walkdirs_win32
 
93
            scenarios.append(
 
94
                ('win32',
 
95
                 dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
 
96
                      _native_to_unicode=_already_unicode)))
 
97
        except ImportError:
 
98
            pass
 
99
    return scenarios
 
100
 
 
101
 
 
102
load_tests = load_tests_apply_scenarios
 
103
 
 
104
 
 
105
class TestContainsWhitespace(tests.TestCase):
71
106
 
72
107
    def test_contains_whitespace(self):
73
 
        self.failUnless(osutils.contains_whitespace(u' '))
74
 
        self.failUnless(osutils.contains_whitespace(u'hello there'))
75
 
        self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
76
 
        self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
77
 
        self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
78
 
        self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
 
108
        self.assertTrue(osutils.contains_whitespace(u' '))
 
109
        self.assertTrue(osutils.contains_whitespace(u'hello there'))
 
110
        self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
 
111
        self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
 
112
        self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
 
113
        self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
79
114
 
80
115
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
81
116
        # is whitespace, but we do not.
82
 
        self.failIf(osutils.contains_whitespace(u''))
83
 
        self.failIf(osutils.contains_whitespace(u'hellothere'))
84
 
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
 
117
        self.assertFalse(osutils.contains_whitespace(u''))
 
118
        self.assertFalse(osutils.contains_whitespace(u'hellothere'))
 
119
        self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
 
120
 
 
121
 
 
122
class TestRename(tests.TestCaseInTempDir):
 
123
 
 
124
    def create_file(self, filename, content):
 
125
        f = open(filename, 'wb')
 
126
        try:
 
127
            f.write(content)
 
128
        finally:
 
129
            f.close()
 
130
 
 
131
    def _fancy_rename(self, a, b):
 
132
        osutils.fancy_rename(a, b, rename_func=os.rename,
 
133
                             unlink_func=os.unlink)
85
134
 
86
135
    def test_fancy_rename(self):
87
136
        # This should work everywhere
88
 
        def rename(a, b):
89
 
            osutils.fancy_rename(a, b,
90
 
                    rename_func=os.rename,
91
 
                    unlink_func=os.unlink)
92
 
 
93
 
        open('a', 'wb').write('something in a\n')
94
 
        rename('a', 'b')
95
 
        self.failIfExists('a')
96
 
        self.failUnlessExists('b')
 
137
        self.create_file('a', 'something in a\n')
 
138
        self._fancy_rename('a', 'b')
 
139
        self.assertPathDoesNotExist('a')
 
140
        self.assertPathExists('b')
97
141
        self.check_file_contents('b', 'something in a\n')
98
142
 
99
 
        open('a', 'wb').write('new something in a\n')
100
 
        rename('b', 'a')
 
143
        self.create_file('a', 'new something in a\n')
 
144
        self._fancy_rename('b', 'a')
101
145
 
102
146
        self.check_file_contents('a', 'something in a\n')
103
147
 
 
148
    def test_fancy_rename_fails_source_missing(self):
 
149
        # An exception should be raised, and the target should be left in place
 
150
        self.create_file('target', 'data in target\n')
 
151
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
152
                          'missingsource', 'target')
 
153
        self.assertPathExists('target')
 
154
        self.check_file_contents('target', 'data in target\n')
 
155
 
 
156
    def test_fancy_rename_fails_if_source_and_target_missing(self):
 
157
        self.assertRaises((IOError, OSError), self._fancy_rename,
 
158
                          'missingsource', 'missingtarget')
 
159
 
104
160
    def test_rename(self):
105
161
        # Rename should be semi-atomic on all platforms
106
 
        open('a', 'wb').write('something in a\n')
 
162
        self.create_file('a', 'something in a\n')
107
163
        osutils.rename('a', 'b')
108
 
        self.failIfExists('a')
109
 
        self.failUnlessExists('b')
 
164
        self.assertPathDoesNotExist('a')
 
165
        self.assertPathExists('b')
110
166
        self.check_file_contents('b', 'something in a\n')
111
167
 
112
 
        open('a', 'wb').write('new something in a\n')
 
168
        self.create_file('a', 'new something in a\n')
113
169
        osutils.rename('b', 'a')
114
170
 
115
171
        self.check_file_contents('a', 'something in a\n')
126
182
        shape = sorted(os.listdir('.'))
127
183
        self.assertEquals(['A', 'B'], shape)
128
184
 
 
185
    def test_rename_exception(self):
 
186
        try:
 
187
            osutils.rename('nonexistent_path', 'different_nonexistent_path')
 
188
        except OSError, e:
 
189
            self.assertEqual(e.old_filename, 'nonexistent_path')
 
190
            self.assertEqual(e.new_filename, 'different_nonexistent_path')
 
191
            self.assertTrue('nonexistent_path' in e.strerror)
 
192
            self.assertTrue('different_nonexistent_path' in e.strerror)
 
193
 
 
194
 
 
195
class TestRandChars(tests.TestCase):
 
196
 
129
197
    def test_01_rand_chars_empty(self):
130
198
        result = osutils.rand_chars(0)
131
199
        self.assertEqual(result, '')
136
204
        self.assertEqual(type(result), str)
137
205
        self.assertContainsRe(result, r'^[a-z0-9]{100}$')
138
206
 
 
207
 
 
208
class TestIsInside(tests.TestCase):
 
209
 
139
210
    def test_is_inside(self):
140
211
        is_inside = osutils.is_inside
141
212
        self.assertTrue(is_inside('src', 'src/foo.c'))
170
241
                         (['src'], 'srccontrol/foo')]:
171
242
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
172
243
 
 
244
 
 
245
class TestLstat(tests.TestCaseInTempDir):
 
246
 
 
247
    def test_lstat_matches_fstat(self):
 
248
        # On Windows, lstat and fstat don't always agree, primarily in the
 
249
        # 'st_ino' and 'st_dev' fields. So we force them to be '0' in our
 
250
        # custom implementation.
 
251
        if sys.platform == 'win32':
 
252
            # We only have special lstat/fstat if we have the extension.
 
253
            # Without it, we may end up re-reading content when we don't have
 
254
            # to, but otherwise it doesn't effect correctness.
 
255
            self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
256
        f = open('test-file.txt', 'wb')
 
257
        self.addCleanup(f.close)
 
258
        f.write('some content\n')
 
259
        f.flush()
 
260
        self.assertEqualStat(osutils.fstat(f.fileno()),
 
261
                             osutils.lstat('test-file.txt'))
 
262
 
 
263
 
 
264
class TestRmTree(tests.TestCaseInTempDir):
 
265
 
173
266
    def test_rmtree(self):
174
267
        # Check to remove tree with read-only files/dirs
175
268
        os.mkdir('dir')
185
278
 
186
279
        osutils.rmtree('dir')
187
280
 
188
 
        self.failIfExists('dir/file')
189
 
        self.failIfExists('dir')
 
281
        self.assertPathDoesNotExist('dir/file')
 
282
        self.assertPathDoesNotExist('dir')
 
283
 
 
284
 
 
285
class TestDeleteAny(tests.TestCaseInTempDir):
 
286
 
 
287
    def test_delete_any_readonly(self):
 
288
        # from <https://bugs.launchpad.net/bzr/+bug/218206>
 
289
        self.build_tree(['d/', 'f'])
 
290
        osutils.make_readonly('d')
 
291
        osutils.make_readonly('f')
 
292
 
 
293
        osutils.delete_any('f')
 
294
        osutils.delete_any('d')
 
295
 
 
296
 
 
297
class TestKind(tests.TestCaseInTempDir):
190
298
 
191
299
    def test_file_kind(self):
192
300
        self.build_tree(['file', 'dir/'])
223
331
                os.remove('socket')
224
332
 
225
333
    def test_kind_marker(self):
226
 
        self.assertEqual(osutils.kind_marker('file'), '')
227
 
        self.assertEqual(osutils.kind_marker('directory'), '/')
228
 
        self.assertEqual(osutils.kind_marker('symlink'), '@')
229
 
        self.assertEqual(osutils.kind_marker('tree-reference'), '+')
 
334
        self.assertEqual("", osutils.kind_marker("file"))
 
335
        self.assertEqual("/", osutils.kind_marker('directory'))
 
336
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
 
337
        self.assertEqual("@", osutils.kind_marker("symlink"))
 
338
        self.assertEqual("+", osutils.kind_marker("tree-reference"))
 
339
        self.assertEqual("", osutils.kind_marker("fifo"))
 
340
        self.assertEqual("", osutils.kind_marker("socket"))
 
341
        self.assertEqual("", osutils.kind_marker("unknown"))
 
342
 
 
343
 
 
344
class TestUmask(tests.TestCaseInTempDir):
230
345
 
231
346
    def test_get_umask(self):
232
347
        if sys.platform == 'win32':
235
350
            return
236
351
 
237
352
        orig_umask = osutils.get_umask()
238
 
        try:
239
 
            os.umask(0222)
240
 
            self.assertEqual(0222, osutils.get_umask())
241
 
            os.umask(0022)
242
 
            self.assertEqual(0022, osutils.get_umask())
243
 
            os.umask(0002)
244
 
            self.assertEqual(0002, osutils.get_umask())
245
 
            os.umask(0027)
246
 
            self.assertEqual(0027, osutils.get_umask())
247
 
        finally:
248
 
            os.umask(orig_umask)
 
353
        self.addCleanup(os.umask, orig_umask)
 
354
        os.umask(0222)
 
355
        self.assertEqual(0222, osutils.get_umask())
 
356
        os.umask(0022)
 
357
        self.assertEqual(0022, osutils.get_umask())
 
358
        os.umask(0002)
 
359
        self.assertEqual(0002, osutils.get_umask())
 
360
        os.umask(0027)
 
361
        self.assertEqual(0027, osutils.get_umask())
 
362
 
 
363
 
 
364
class TestDateTime(tests.TestCase):
249
365
 
250
366
    def assertFormatedDelta(self, expected, seconds):
251
367
        """Assert osutils.format_delta formats as expected"""
293
409
        # Instead blackbox.test_locale should check for localized
294
410
        # dates once they do occur in output strings.
295
411
 
 
412
    def test_format_date_with_offset_in_original_timezone(self):
 
413
        self.assertEqual("Thu 1970-01-01 00:00:00 +0000",
 
414
            osutils.format_date_with_offset_in_original_timezone(0))
 
415
        self.assertEqual("Fri 1970-01-02 03:46:40 +0000",
 
416
            osutils.format_date_with_offset_in_original_timezone(100000))
 
417
        self.assertEqual("Fri 1970-01-02 05:46:40 +0200",
 
418
            osutils.format_date_with_offset_in_original_timezone(100000, 7200))
 
419
 
 
420
    def test_local_time_offset(self):
 
421
        """Test that local_time_offset() returns a sane value."""
 
422
        offset = osutils.local_time_offset()
 
423
        self.assertTrue(isinstance(offset, int))
 
424
        # Test that the offset is no more than a eighteen hours in
 
425
        # either direction.
 
426
        # Time zone handling is system specific, so it is difficult to
 
427
        # do more specific tests, but a value outside of this range is
 
428
        # probably wrong.
 
429
        eighteen_hours = 18 * 3600
 
430
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
431
 
 
432
    def test_local_time_offset_with_timestamp(self):
 
433
        """Test that local_time_offset() works with a timestamp."""
 
434
        offset = osutils.local_time_offset(1000000000.1234567)
 
435
        self.assertTrue(isinstance(offset, int))
 
436
        eighteen_hours = 18 * 3600
 
437
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
438
 
 
439
 
 
440
class TestFdatasync(tests.TestCaseInTempDir):
 
441
 
 
442
    def do_fdatasync(self):
 
443
        f = tempfile.NamedTemporaryFile()
 
444
        osutils.fdatasync(f.fileno())
 
445
        f.close()
 
446
 
 
447
    @staticmethod
 
448
    def raise_eopnotsupp(*args, **kwargs):
 
449
        raise IOError(errno.EOPNOTSUPP, os.strerror(errno.EOPNOTSUPP))
 
450
 
 
451
    @staticmethod
 
452
    def raise_enotsup(*args, **kwargs):
 
453
        raise IOError(errno.ENOTSUP, os.strerror(errno.ENOTSUP))
 
454
 
 
455
    def test_fdatasync_handles_system_function(self):
 
456
        self.overrideAttr(os, "fdatasync")
 
457
        self.do_fdatasync()
 
458
 
 
459
    def test_fdatasync_handles_no_fdatasync_no_fsync(self):
 
460
        self.overrideAttr(os, "fdatasync")
 
461
        self.overrideAttr(os, "fsync")
 
462
        self.do_fdatasync()
 
463
 
 
464
    def test_fdatasync_handles_no_EOPNOTSUPP(self):
 
465
        self.overrideAttr(errno, "EOPNOTSUPP")
 
466
        self.do_fdatasync()
 
467
 
 
468
    def test_fdatasync_catches_ENOTSUP(self):
 
469
        enotsup = getattr(errno, "ENOTSUP", None)
 
470
        if enotsup is None:
 
471
            raise tests.TestNotApplicable("No ENOTSUP on this platform")
 
472
        self.overrideAttr(os, "fdatasync", self.raise_enotsup)
 
473
        self.do_fdatasync()
 
474
 
 
475
    def test_fdatasync_catches_EOPNOTSUPP(self):
 
476
        enotsup = getattr(errno, "EOPNOTSUPP", None)
 
477
        if enotsup is None:
 
478
            raise tests.TestNotApplicable("No EOPNOTSUPP on this platform")
 
479
        self.overrideAttr(os, "fdatasync", self.raise_eopnotsupp)
 
480
        self.do_fdatasync()
 
481
 
 
482
 
 
483
class TestLinks(tests.TestCaseInTempDir):
 
484
 
296
485
    def test_dereference_path(self):
297
 
        self.requireFeature(SymlinkFeature)
 
486
        self.requireFeature(features.SymlinkFeature)
298
487
        cwd = osutils.realpath('.')
299
488
        os.mkdir('bar')
300
489
        bar_path = osutils.pathjoin(cwd, 'bar')
341
530
            osutils.make_readonly('dangling')
342
531
            osutils.make_writable('dangling')
343
532
 
344
 
    def test_kind_marker(self):
345
 
        self.assertEqual("", osutils.kind_marker("file"))
346
 
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
347
 
        self.assertEqual("@", osutils.kind_marker("symlink"))
348
 
        self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
349
 
 
350
533
    def test_host_os_dereferences_symlinks(self):
351
534
        osutils.host_os_dereferences_symlinks()
352
535
 
353
536
 
354
 
class TestCanonicalRelPath(TestCaseInTempDir):
 
537
class TestCanonicalRelPath(tests.TestCaseInTempDir):
355
538
 
356
 
    _test_needs_features = [CaseInsCasePresFilenameFeature]
 
539
    _test_needs_features = [features.CaseInsCasePresFilenameFeature]
357
540
 
358
541
    def test_canonical_relpath_simple(self):
359
542
        f = file('MixedCaseName', 'w')
360
543
        f.close()
361
 
        # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
362
 
        real_base_dir = osutils.realpath(self.test_base_dir)
363
 
        actual = osutils.canonical_relpath(real_base_dir, 'mixedcasename')
364
 
        self.failUnlessEqual('work/MixedCaseName', actual)
 
544
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
 
545
        self.assertEqual('work/MixedCaseName', actual)
365
546
 
366
547
    def test_canonical_relpath_missing_tail(self):
367
548
        os.mkdir('MixedCaseParent')
368
 
        # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
369
 
        real_base_dir = osutils.realpath(self.test_base_dir)
370
 
        actual = osutils.canonical_relpath(real_base_dir,
 
549
        actual = osutils.canonical_relpath(self.test_base_dir,
371
550
                                           'mixedcaseparent/nochild')
372
 
        self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
373
 
 
374
 
 
375
 
class TestPumpFile(TestCase):
 
551
        self.assertEqual('work/MixedCaseParent/nochild', actual)
 
552
 
 
553
 
 
554
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
 
555
 
 
556
    def assertRelpath(self, expected, base, path):
 
557
        actual = osutils._cicp_canonical_relpath(base, path)
 
558
        self.assertEqual(expected, actual)
 
559
 
 
560
    def test_simple(self):
 
561
        self.build_tree(['MixedCaseName'])
 
562
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
563
        self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
 
564
 
 
565
    def test_subdir_missing_tail(self):
 
566
        self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
 
567
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
 
568
        self.assertRelpath('MixedCaseParent/a_child', base,
 
569
                           'MixedCaseParent/a_child')
 
570
        self.assertRelpath('MixedCaseParent/a_child', base,
 
571
                           'MixedCaseParent/A_Child')
 
572
        self.assertRelpath('MixedCaseParent/not_child', base,
 
573
                           'MixedCaseParent/not_child')
 
574
 
 
575
    def test_at_root_slash(self):
 
576
        # We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
 
577
        # check...
 
578
        if osutils.MIN_ABS_PATHLENGTH > 1:
 
579
            raise tests.TestSkipped('relpath requires %d chars'
 
580
                                    % osutils.MIN_ABS_PATHLENGTH)
 
581
        self.assertRelpath('foo', '/', '/foo')
 
582
 
 
583
    def test_at_root_drive(self):
 
584
        if sys.platform != 'win32':
 
585
            raise tests.TestNotApplicable('we can only test drive-letter relative'
 
586
                                          ' paths on Windows where we have drive'
 
587
                                          ' letters.')
 
588
        # see bug #322807
 
589
        # The specific issue is that when at the root of a drive, 'abspath'
 
590
        # returns "C:/" or just "/". However, the code assumes that abspath
 
591
        # always returns something like "C:/foo" or "/foo" (no trailing slash).
 
592
        self.assertRelpath('foo', 'C:/', 'C:/foo')
 
593
        self.assertRelpath('foo', 'X:/', 'X:/foo')
 
594
        self.assertRelpath('foo', 'X:/', 'X://foo')
 
595
 
 
596
 
 
597
class TestPumpFile(tests.TestCase):
376
598
    """Test pumpfile method."""
 
599
 
377
600
    def setUp(self):
378
 
        TestCase.setUp(self)
 
601
        super(TestPumpFile, self).setUp()
379
602
        # create a test datablock
380
603
        self.block_size = 512
381
604
        pattern = '0123456789ABCDEF'
388
611
        # make sure test data is larger than max read size
389
612
        self.assertTrue(self.test_data_len > self.block_size)
390
613
 
391
 
        from_file = FakeReadFile(self.test_data)
 
614
        from_file = file_utils.FakeReadFile(self.test_data)
392
615
        to_file = StringIO()
393
616
 
394
617
        # read (max / 2) bytes and verify read size wasn't affected
429
652
        self.assertTrue(self.test_data_len > self.block_size)
430
653
 
431
654
        # retrieve data in blocks
432
 
        from_file = FakeReadFile(self.test_data)
 
655
        from_file = file_utils.FakeReadFile(self.test_data)
433
656
        to_file = StringIO()
434
657
        osutils.pumpfile(from_file, to_file, self.test_data_len,
435
658
                         self.block_size)
453
676
        self.assertTrue(self.test_data_len > self.block_size)
454
677
 
455
678
        # retrieve data to EOF
456
 
        from_file = FakeReadFile(self.test_data)
 
679
        from_file = file_utils.FakeReadFile(self.test_data)
457
680
        to_file = StringIO()
458
681
        osutils.pumpfile(from_file, to_file, -1, self.block_size)
459
682
 
473
696
        test verifies that any existing usages of pumpfile will not be broken
474
697
        with this new version."""
475
698
        # retrieve data using default (old) pumpfile method
476
 
        from_file = FakeReadFile(self.test_data)
 
699
        from_file = file_utils.FakeReadFile(self.test_data)
477
700
        to_file = StringIO()
478
701
        osutils.pumpfile(from_file, to_file)
479
702
 
513
736
 
514
737
 
515
738
 
516
 
class TestPumpStringFile(TestCase):
 
739
class TestPumpStringFile(tests.TestCase):
517
740
 
518
741
    def test_empty(self):
519
742
        output = StringIO()
536
759
        self.assertEqual("1234", output.getvalue())
537
760
 
538
761
 
539
 
class TestSafeUnicode(TestCase):
 
762
class TestRelpath(tests.TestCase):
 
763
 
 
764
    def test_simple_relpath(self):
 
765
        cwd = osutils.getcwd()
 
766
        subdir = cwd + '/subdir'
 
767
        self.assertEqual('subdir', osutils.relpath(cwd, subdir))
 
768
 
 
769
    def test_deep_relpath(self):
 
770
        cwd = osutils.getcwd()
 
771
        subdir = cwd + '/sub/subsubdir'
 
772
        self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
 
773
 
 
774
    def test_not_relative(self):
 
775
        self.assertRaises(errors.PathNotChild,
 
776
                          osutils.relpath, 'C:/path', 'H:/path')
 
777
        self.assertRaises(errors.PathNotChild,
 
778
                          osutils.relpath, 'C:/', 'H:/path')
 
779
 
 
780
 
 
781
class TestSafeUnicode(tests.TestCase):
540
782
 
541
783
    def test_from_ascii_string(self):
542
784
        self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
551
793
        self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
552
794
 
553
795
    def test_bad_utf8_string(self):
554
 
        self.assertRaises(BzrBadParameterNotUnicode,
 
796
        self.assertRaises(errors.BzrBadParameterNotUnicode,
555
797
                          osutils.safe_unicode,
556
798
                          '\xbb\xbb')
557
799
 
558
800
 
559
 
class TestSafeUtf8(TestCase):
 
801
class TestSafeUtf8(tests.TestCase):
560
802
 
561
803
    def test_from_ascii_string(self):
562
804
        f = 'foobar'
572
814
        self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
573
815
 
574
816
    def test_bad_utf8_string(self):
575
 
        self.assertRaises(BzrBadParameterNotUnicode,
 
817
        self.assertRaises(errors.BzrBadParameterNotUnicode,
576
818
                          osutils.safe_utf8, '\xbb\xbb')
577
819
 
578
820
 
579
 
class TestSafeRevisionId(TestCase):
 
821
class TestSafeRevisionId(tests.TestCase):
580
822
 
581
823
    def test_from_ascii_string(self):
582
824
        # this shouldn't give a warning because it's getting an ascii string
604
846
        self.assertEqual(None, osutils.safe_revision_id(None))
605
847
 
606
848
 
607
 
class TestSafeFileId(TestCase):
 
849
class TestSafeFileId(tests.TestCase):
608
850
 
609
851
    def test_from_ascii_string(self):
610
852
        self.assertEqual('foobar', osutils.safe_file_id('foobar'))
630
872
        self.assertEqual(None, osutils.safe_file_id(None))
631
873
 
632
874
 
633
 
class TestWin32Funcs(TestCase):
634
 
    """Test that the _win32 versions of os utilities return appropriate paths."""
 
875
class TestSendAll(tests.TestCase):
 
876
 
 
877
    def test_send_with_disconnected_socket(self):
 
878
        class DisconnectedSocket(object):
 
879
            def __init__(self, err):
 
880
                self.err = err
 
881
            def send(self, content):
 
882
                raise self.err
 
883
            def close(self):
 
884
                pass
 
885
        # All of these should be treated as ConnectionReset
 
886
        errs = []
 
887
        for err_cls in (IOError, socket.error):
 
888
            for errnum in osutils._end_of_stream_errors:
 
889
                errs.append(err_cls(errnum))
 
890
        for err in errs:
 
891
            sock = DisconnectedSocket(err)
 
892
            self.assertRaises(errors.ConnectionReset,
 
893
                osutils.send_all, sock, 'some more content')
 
894
 
 
895
    def test_send_with_no_progress(self):
 
896
        # See https://bugs.launchpad.net/bzr/+bug/1047309
 
897
        # It seems that paramiko can get into a state where it doesn't error,
 
898
        # but it returns 0 bytes sent for requests over and over again.
 
899
        class NoSendingSocket(object):
 
900
            def __init__(self):
 
901
                self.call_count = 0
 
902
            def send(self, bytes):
 
903
                self.call_count += 1
 
904
                if self.call_count > 100:
 
905
                    # Prevent the test suite from hanging
 
906
                    raise RuntimeError('too many calls')
 
907
                return 0
 
908
        sock = NoSendingSocket()
 
909
        self.assertRaises(errors.ConnectionReset,
 
910
                          osutils.send_all, sock, 'content')
 
911
        self.assertEqual(1, sock.call_count)
 
912
 
 
913
 
 
914
class TestPosixFuncs(tests.TestCase):
 
915
    """Test that the posix version of normpath returns an appropriate path
 
916
       when used with 2 leading slashes."""
 
917
 
 
918
    def test_normpath(self):
 
919
        self.assertEqual('/etc/shadow', osutils._posix_normpath('/etc/shadow'))
 
920
        self.assertEqual('/etc/shadow', osutils._posix_normpath('//etc/shadow'))
 
921
        self.assertEqual('/etc/shadow', osutils._posix_normpath('///etc/shadow'))
 
922
 
 
923
 
 
924
class TestWin32Funcs(tests.TestCase):
 
925
    """Test that _win32 versions of os utilities return appropriate paths."""
635
926
 
636
927
    def test_abspath(self):
 
928
        self.requireFeature(features.win32_feature)
637
929
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
638
930
        self.assertEqual('C:/foo', osutils._win32_abspath('C:/foo'))
639
931
        self.assertEqual('//HOST/path', osutils._win32_abspath(r'\\HOST\path'))
644
936
        self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
645
937
 
646
938
    def test_pathjoin(self):
647
 
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path', 'to', 'foo'))
648
 
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path\\to', 'C:\\foo'))
649
 
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path/to', 'C:/foo'))
650
 
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path/to/', 'foo'))
651
 
        self.assertEqual('/foo', osutils._win32_pathjoin('C:/path/to/', '/foo'))
652
 
        self.assertEqual('/foo', osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
 
939
        self.assertEqual('path/to/foo',
 
940
                         osutils._win32_pathjoin('path', 'to', 'foo'))
 
941
        self.assertEqual('C:/foo',
 
942
                         osutils._win32_pathjoin('path\\to', 'C:\\foo'))
 
943
        self.assertEqual('C:/foo',
 
944
                         osutils._win32_pathjoin('path/to', 'C:/foo'))
 
945
        self.assertEqual('path/to/foo',
 
946
                         osutils._win32_pathjoin('path/to/', 'foo'))
 
947
 
 
948
    def test_pathjoin_late_bugfix(self):
 
949
        if sys.version_info < (2, 7, 6):
 
950
            expected = '/foo'
 
951
        else:
 
952
            expected = 'C:/foo'
 
953
        self.assertEqual(expected,
 
954
                         osutils._win32_pathjoin('C:/path/to/', '/foo'))
 
955
        self.assertEqual(expected,
 
956
                         osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
653
957
 
654
958
    def test_normpath(self):
655
 
        self.assertEqual('path/to/foo', osutils._win32_normpath(r'path\\from\..\to\.\foo'))
656
 
        self.assertEqual('path/to/foo', osutils._win32_normpath('path//from/../to/./foo'))
 
959
        self.assertEqual('path/to/foo',
 
960
                         osutils._win32_normpath(r'path\\from\..\to\.\foo'))
 
961
        self.assertEqual('path/to/foo',
 
962
                         osutils._win32_normpath('path//from/../to/./foo'))
657
963
 
658
964
    def test_getcwd(self):
659
965
        cwd = osutils._win32_getcwd()
672
978
        self.assertEqual('C:\\foo', osutils._win32_fixdrive('c:\\foo'))
673
979
 
674
980
    def test_win98_abspath(self):
 
981
        self.requireFeature(features.win32_feature)
675
982
        # absolute path
676
983
        self.assertEqual('C:/foo', osutils._win98_abspath('C:\\foo'))
677
984
        self.assertEqual('C:/foo', osutils._win98_abspath('C:/foo'))
680
987
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
681
988
        # relative path
682
989
        cwd = osutils.getcwd().rstrip('/')
683
 
        drive = osutils._nt_splitdrive(cwd)[0]
 
990
        drive = osutils.ntpath.splitdrive(cwd)[0]
684
991
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
685
992
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
686
993
        # unicode path
688
995
        self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
689
996
 
690
997
 
691
 
class TestWin32FuncsDirs(TestCaseInTempDir):
 
998
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
692
999
    """Test win32 functions that create files."""
693
1000
 
694
1001
    def test_getcwd(self):
695
 
        if win32utils.winver == 'Windows 98':
696
 
            raise TestSkipped('Windows 98 cannot handle unicode filenames')
697
 
        # Make sure getcwd can handle unicode filenames
698
 
        try:
699
 
            os.mkdir(u'mu-\xb5')
700
 
        except UnicodeError:
701
 
            raise TestSkipped("Unable to create Unicode filename")
702
 
 
 
1002
        self.requireFeature(features.UnicodeFilenameFeature)
 
1003
        os.mkdir(u'mu-\xb5')
703
1004
        os.chdir(u'mu-\xb5')
704
1005
        # TODO: jam 20060427 This will probably fail on Mac OSX because
705
1006
        #       it will change the normalization of B\xe5gfors
710
1011
    def test_minimum_path_selection(self):
711
1012
        self.assertEqual(set(),
712
1013
            osutils.minimum_path_selection([]))
 
1014
        self.assertEqual(set(['a']),
 
1015
            osutils.minimum_path_selection(['a']))
713
1016
        self.assertEqual(set(['a', 'b']),
714
1017
            osutils.minimum_path_selection(['a', 'b']))
715
1018
        self.assertEqual(set(['a/', 'b']),
716
1019
            osutils.minimum_path_selection(['a/', 'b']))
717
1020
        self.assertEqual(set(['a/', 'b']),
718
1021
            osutils.minimum_path_selection(['a/c', 'a/', 'b']))
 
1022
        self.assertEqual(set(['a-b', 'a', 'a0b']),
 
1023
            osutils.minimum_path_selection(['a-b', 'a/b', 'a0b', 'a']))
719
1024
 
720
1025
    def test_mkdtemp(self):
721
1026
        tmpdir = osutils._win32_mkdtemp(dir='.')
730
1035
        b.close()
731
1036
 
732
1037
        osutils._win32_rename('b', 'a')
733
 
        self.failUnlessExists('a')
734
 
        self.failIfExists('b')
 
1038
        self.assertPathExists('a')
 
1039
        self.assertPathDoesNotExist('b')
735
1040
        self.assertFileEqual('baz\n', 'a')
736
1041
 
737
1042
    def test_rename_missing_file(self):
777
1082
        self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
778
1083
 
779
1084
 
780
 
class TestMacFuncsDirs(TestCaseInTempDir):
 
1085
class TestParentDirectories(tests.TestCaseInTempDir):
 
1086
    """Test osutils.parent_directories()"""
 
1087
 
 
1088
    def test_parent_directories(self):
 
1089
        self.assertEqual([], osutils.parent_directories('a'))
 
1090
        self.assertEqual(['a'], osutils.parent_directories('a/b'))
 
1091
        self.assertEqual(['a/b', 'a'], osutils.parent_directories('a/b/c'))
 
1092
 
 
1093
 
 
1094
class TestMacFuncsDirs(tests.TestCaseInTempDir):
781
1095
    """Test mac special functions that require directories."""
782
1096
 
783
1097
    def test_getcwd(self):
784
 
        # On Mac, this will actually create Ba\u030agfors
785
 
        # but chdir will still work, because it accepts both paths
786
 
        try:
787
 
            os.mkdir(u'B\xe5gfors')
788
 
        except UnicodeError:
789
 
            raise TestSkipped("Unable to create Unicode filename")
790
 
 
 
1098
        self.requireFeature(features.UnicodeFilenameFeature)
 
1099
        os.mkdir(u'B\xe5gfors')
791
1100
        os.chdir(u'B\xe5gfors')
792
1101
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
793
1102
 
794
1103
    def test_getcwd_nonnorm(self):
 
1104
        self.requireFeature(features.UnicodeFilenameFeature)
795
1105
        # Test that _mac_getcwd() will normalize this path
796
 
        try:
797
 
            os.mkdir(u'Ba\u030agfors')
798
 
        except UnicodeError:
799
 
            raise TestSkipped("Unable to create Unicode filename")
800
 
 
 
1106
        os.mkdir(u'Ba\u030agfors')
801
1107
        os.chdir(u'Ba\u030agfors')
802
1108
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
803
1109
 
804
1110
 
805
 
class TestChunksToLines(TestCase):
 
1111
class TestChunksToLines(tests.TestCase):
806
1112
 
807
1113
    def test_smoketest(self):
808
1114
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
812
1118
 
813
1119
    def test_osutils_binding(self):
814
1120
        from bzrlib.tests import test__chunks_to_lines
815
 
        if test__chunks_to_lines.CompiledChunksToLinesFeature.available():
 
1121
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
816
1122
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
817
1123
        else:
818
1124
            from bzrlib._chunks_to_lines_py import chunks_to_lines
819
1125
        self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
820
1126
 
821
1127
 
822
 
class TestSplitLines(TestCase):
 
1128
class TestSplitLines(tests.TestCase):
823
1129
 
824
1130
    def test_split_unicode(self):
825
1131
        self.assertEqual([u'foo\n', u'bar\xae'],
832
1138
                         osutils.split_lines('foo\rbar\n'))
833
1139
 
834
1140
 
835
 
class TestWalkDirs(TestCaseInTempDir):
 
1141
class TestWalkDirs(tests.TestCaseInTempDir):
 
1142
 
 
1143
    def assertExpectedBlocks(self, expected, result):
 
1144
        self.assertEqual(expected,
 
1145
                         [(dirinfo, [line[0:3] for line in block])
 
1146
                          for dirinfo, block in result])
836
1147
 
837
1148
    def test_walkdirs(self):
838
1149
        tree = [
871
1182
            result.append((dirdetail, dirblock))
872
1183
 
873
1184
        self.assertTrue(found_bzrdir)
874
 
        self.assertEqual(expected_dirblocks,
875
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1185
        self.assertExpectedBlocks(expected_dirblocks, result)
876
1186
        # you can search a subdir only, with a supplied prefix.
877
1187
        result = []
878
1188
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
879
1189
            result.append(dirblock)
880
 
        self.assertEqual(expected_dirblocks[1:],
881
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1190
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
882
1191
 
883
1192
    def test_walkdirs_os_error(self):
884
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/338653>
 
1193
        # <https://bugs.launchpad.net/bzr/+bug/338653>
885
1194
        # Pyrex readdir didn't raise useful messages if it had an error
886
1195
        # reading the directory
887
1196
        if sys.platform == 'win32':
888
1197
            raise tests.TestNotApplicable(
889
1198
                "readdir IOError not tested on win32")
 
1199
        self.requireFeature(features.not_running_as_root)
890
1200
        os.mkdir("test-unreadable")
891
1201
        os.chmod("test-unreadable", 0000)
892
1202
        # must chmod it back so that it can be removed
893
 
        self.addCleanup(lambda: os.chmod("test-unreadable", 0700))
 
1203
        self.addCleanup(os.chmod, "test-unreadable", 0700)
894
1204
        # The error is not raised until the generator is actually evaluated.
895
1205
        # (It would be ok if it happened earlier but at the moment it
896
1206
        # doesn't.)
900
1210
        # Ensure the message contains the file name
901
1211
        self.assertContainsRe(str(e), "\./test-unreadable")
902
1212
 
 
1213
 
 
1214
    def test_walkdirs_encoding_error(self):
 
1215
        # <https://bugs.launchpad.net/bzr/+bug/488519>
 
1216
        # walkdirs didn't raise a useful message when the filenames
 
1217
        # are not using the filesystem's encoding
 
1218
 
 
1219
        # require a bytestring based filesystem
 
1220
        self.requireFeature(features.ByteStringNamedFilesystem)
 
1221
 
 
1222
        tree = [
 
1223
            '.bzr',
 
1224
            '0file',
 
1225
            '1dir/',
 
1226
            '1dir/0file',
 
1227
            '1dir/1dir/',
 
1228
            '1file'
 
1229
            ]
 
1230
 
 
1231
        self.build_tree(tree)
 
1232
 
 
1233
        # rename the 1file to a latin-1 filename
 
1234
        os.rename("./1file", "\xe8file")
 
1235
        if "\xe8file" not in os.listdir("."):
 
1236
            self.skip("Lack filesystem that preserves arbitrary bytes")
 
1237
 
 
1238
        self._save_platform_info()
 
1239
        win32utils.winver = None # Avoid the win32 detection code
 
1240
        osutils._fs_enc = 'UTF-8'
 
1241
 
 
1242
        # this should raise on error
 
1243
        def attempt():
 
1244
            for dirdetail, dirblock in osutils.walkdirs('.'):
 
1245
                pass
 
1246
 
 
1247
        self.assertRaises(errors.BadFilenameEncoding, attempt)
 
1248
 
903
1249
    def test__walkdirs_utf8(self):
904
1250
        tree = [
905
1251
            '.bzr',
937
1283
            result.append((dirdetail, dirblock))
938
1284
 
939
1285
        self.assertTrue(found_bzrdir)
940
 
        self.assertEqual(expected_dirblocks,
941
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1286
        self.assertExpectedBlocks(expected_dirblocks, result)
 
1287
 
942
1288
        # you can search a subdir only, with a supplied prefix.
943
1289
        result = []
944
1290
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
945
1291
            result.append(dirblock)
946
 
        self.assertEqual(expected_dirblocks[1:],
947
 
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
 
1292
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
948
1293
 
949
1294
    def _filter_out_stat(self, result):
950
1295
        """Filter out the stat value from the walkdirs result"""
956
1301
            dirblock[:] = new_dirblock
957
1302
 
958
1303
    def _save_platform_info(self):
959
 
        cur_winver = win32utils.winver
960
 
        cur_fs_enc = osutils._fs_enc
961
 
        cur_dir_reader = osutils._selected_dir_reader
962
 
        def restore():
963
 
            win32utils.winver = cur_winver
964
 
            osutils._fs_enc = cur_fs_enc
965
 
            osutils._selected_dir_reader = cur_dir_reader
966
 
        self.addCleanup(restore)
 
1304
        self.overrideAttr(win32utils, 'winver')
 
1305
        self.overrideAttr(osutils, '_fs_enc')
 
1306
        self.overrideAttr(osutils, '_selected_dir_reader')
967
1307
 
968
 
    def assertReadFSDirIs(self, expected):
 
1308
    def assertDirReaderIs(self, expected):
969
1309
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
970
1310
        # Force it to redetect
971
1311
        osutils._selected_dir_reader = None
977
1317
        self.requireFeature(UTF8DirReaderFeature)
978
1318
        self._save_platform_info()
979
1319
        win32utils.winver = None # Avoid the win32 detection code
980
 
        osutils._fs_enc = 'UTF-8'
981
 
        self.assertReadFSDirIs(UTF8DirReaderFeature.reader)
 
1320
        osutils._fs_enc = 'utf-8'
 
1321
        self.assertDirReaderIs(
 
1322
            UTF8DirReaderFeature.module.UTF8DirReader)
982
1323
 
983
1324
    def test_force_walkdirs_utf8_fs_ascii(self):
984
1325
        self.requireFeature(UTF8DirReaderFeature)
985
1326
        self._save_platform_info()
986
1327
        win32utils.winver = None # Avoid the win32 detection code
987
 
        osutils._fs_enc = 'US-ASCII'
988
 
        self.assertReadFSDirIs(UTF8DirReaderFeature.reader)
989
 
 
990
 
    def test_force_walkdirs_utf8_fs_ANSI(self):
991
 
        self.requireFeature(UTF8DirReaderFeature)
992
 
        self._save_platform_info()
993
 
        win32utils.winver = None # Avoid the win32 detection code
994
 
        osutils._fs_enc = 'ANSI_X3.4-1968'
995
 
        self.assertReadFSDirIs(UTF8DirReaderFeature.reader)
 
1328
        osutils._fs_enc = 'ascii'
 
1329
        self.assertDirReaderIs(
 
1330
            UTF8DirReaderFeature.module.UTF8DirReader)
996
1331
 
997
1332
    def test_force_walkdirs_utf8_fs_latin1(self):
998
1333
        self._save_platform_info()
999
1334
        win32utils.winver = None # Avoid the win32 detection code
1000
 
        osutils._fs_enc = 'latin1'
1001
 
        self.assertReadFSDirIs(osutils.UnicodeDirReader)
 
1335
        osutils._fs_enc = 'iso-8859-1'
 
1336
        self.assertDirReaderIs(osutils.UnicodeDirReader)
1002
1337
 
1003
1338
    def test_force_walkdirs_utf8_nt(self):
1004
1339
        # Disabled because the thunk of the whole walkdirs api is disabled.
1005
 
        self.requireFeature(Win32ReadDirFeature)
 
1340
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1006
1341
        self._save_platform_info()
1007
1342
        win32utils.winver = 'Windows NT'
1008
1343
        from bzrlib._walkdirs_win32 import Win32ReadDir
1009
 
        self.assertReadFSDirIs(Win32ReadDir)
 
1344
        self.assertDirReaderIs(Win32ReadDir)
1010
1345
 
1011
1346
    def test_force_walkdirs_utf8_98(self):
1012
 
        self.requireFeature(Win32ReadDirFeature)
 
1347
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1013
1348
        self._save_platform_info()
1014
1349
        win32utils.winver = 'Windows 98'
1015
 
        self.assertReadFSDirIs(osutils.UnicodeDirReader)
 
1350
        self.assertDirReaderIs(osutils.UnicodeDirReader)
1016
1351
 
1017
1352
    def test_unicode_walkdirs(self):
1018
1353
        """Walkdirs should always return unicode paths."""
 
1354
        self.requireFeature(features.UnicodeFilenameFeature)
1019
1355
        name0 = u'0file-\xb6'
1020
1356
        name1 = u'1dir-\u062c\u0648'
1021
1357
        name2 = u'2file-\u0633'
1026
1362
            name1 + '/' + name1 + '/',
1027
1363
            name2,
1028
1364
            ]
1029
 
        try:
1030
 
            self.build_tree(tree)
1031
 
        except UnicodeError:
1032
 
            raise TestSkipped('Could not represent Unicode chars'
1033
 
                              ' in current encoding.')
 
1365
        self.build_tree(tree)
1034
1366
        expected_dirblocks = [
1035
1367
                ((u'', u'.'),
1036
1368
                 [(name0, name0, 'file', './' + name0),
1062
1394
 
1063
1395
        The abspath portion might be in unicode or utf-8
1064
1396
        """
 
1397
        self.requireFeature(features.UnicodeFilenameFeature)
1065
1398
        name0 = u'0file-\xb6'
1066
1399
        name1 = u'1dir-\u062c\u0648'
1067
1400
        name2 = u'2file-\u0633'
1072
1405
            name1 + '/' + name1 + '/',
1073
1406
            name2,
1074
1407
            ]
1075
 
        try:
1076
 
            self.build_tree(tree)
1077
 
        except UnicodeError:
1078
 
            raise TestSkipped('Could not represent Unicode chars'
1079
 
                              ' in current encoding.')
 
1408
        self.build_tree(tree)
1080
1409
        name0 = name0.encode('utf8')
1081
1410
        name1 = name1.encode('utf8')
1082
1411
        name2 = name2.encode('utf8')
1126
1455
 
1127
1456
        The abspath portion should be in unicode
1128
1457
        """
 
1458
        self.requireFeature(features.UnicodeFilenameFeature)
1129
1459
        # Use the unicode reader. TODO: split into driver-and-driven unit
1130
1460
        # tests.
1131
1461
        self._save_platform_info()
1140
1470
            name1u + '/' + name1u + '/',
1141
1471
            name2u,
1142
1472
            ]
1143
 
        try:
1144
 
            self.build_tree(tree)
1145
 
        except UnicodeError:
1146
 
            raise TestSkipped('Could not represent Unicode chars'
1147
 
                              ' in current encoding.')
 
1473
        self.build_tree(tree)
1148
1474
        name0 = name0u.encode('utf8')
1149
1475
        name1 = name1u.encode('utf8')
1150
1476
        name2 = name2u.encode('utf8')
1175
1501
        self.assertEqual(expected_dirblocks, result)
1176
1502
 
1177
1503
    def test__walkdirs_utf8_win32readdir(self):
1178
 
        self.requireFeature(Win32ReadDirFeature)
1179
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1504
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1505
        self.requireFeature(features.UnicodeFilenameFeature)
1180
1506
        from bzrlib._walkdirs_win32 import Win32ReadDir
1181
1507
        self._save_platform_info()
1182
1508
        osutils._selected_dir_reader = Win32ReadDir()
1232
1558
 
1233
1559
    def test__walkdirs_utf_win32_find_file_stat_file(self):
1234
1560
        """make sure our Stat values are valid"""
1235
 
        self.requireFeature(Win32ReadDirFeature)
1236
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1561
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1562
        self.requireFeature(features.UnicodeFilenameFeature)
1237
1563
        from bzrlib._walkdirs_win32 import Win32ReadDir
1238
1564
        name0u = u'0file-\xb6'
1239
1565
        name0 = name0u.encode('utf8')
1256
1582
 
1257
1583
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
1258
1584
        """make sure our Stat values are valid"""
1259
 
        self.requireFeature(Win32ReadDirFeature)
1260
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1585
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1586
        self.requireFeature(features.UnicodeFilenameFeature)
1261
1587
        from bzrlib._walkdirs_win32 import Win32ReadDir
1262
1588
        name0u = u'0dir-\u062c\u0648'
1263
1589
        name0 = name0u.encode('utf8')
1347
1673
            sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
1348
1674
 
1349
1675
 
1350
 
class TestCopyTree(TestCaseInTempDir):
 
1676
class TestCopyTree(tests.TestCaseInTempDir):
1351
1677
 
1352
1678
    def test_copy_basic_tree(self):
1353
1679
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1363
1689
        self.assertEqual(['c'], os.listdir('target/b'))
1364
1690
 
1365
1691
    def test_copy_tree_symlinks(self):
1366
 
        self.requireFeature(SymlinkFeature)
 
1692
        self.requireFeature(features.SymlinkFeature)
1367
1693
        self.build_tree(['source/'])
1368
1694
        os.symlink('a/generic/path', 'source/lnk')
1369
1695
        osutils.copy_tree('source', 'target')
1394
1720
                          ('d', 'source/b', 'target/b'),
1395
1721
                          ('f', 'source/b/c', 'target/b/c'),
1396
1722
                         ], processed_files)
1397
 
        self.failIfExists('target')
 
1723
        self.assertPathDoesNotExist('target')
1398
1724
        if osutils.has_symlinks():
1399
1725
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1400
1726
 
1401
1727
 
1402
 
#class TestTerminalEncoding has been moved to test_osutils_encodings.py
1403
 
# [bialix] 2006/12/26
1404
 
 
1405
 
 
1406
 
class TestSetUnsetEnv(TestCase):
 
1728
class TestSetUnsetEnv(tests.TestCase):
1407
1729
    """Test updating the environment"""
1408
1730
 
1409
1731
    def setUp(self):
1415
1737
        def cleanup():
1416
1738
            if 'BZR_TEST_ENV_VAR' in os.environ:
1417
1739
                del os.environ['BZR_TEST_ENV_VAR']
1418
 
 
1419
1740
        self.addCleanup(cleanup)
1420
1741
 
1421
1742
    def test_set(self):
1436
1757
 
1437
1758
        So Unicode strings must be encoded.
1438
1759
        """
1439
 
        uni_val, env_val = probe_unicode_in_user_encoding()
 
1760
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
1440
1761
        if uni_val is None:
1441
 
            raise TestSkipped('Cannot find a unicode character that works in'
1442
 
                              ' encoding %s' % (osutils.get_user_encoding(),))
 
1762
            raise tests.TestSkipped(
 
1763
                'Cannot find a unicode character that works in encoding %s'
 
1764
                % (osutils.get_user_encoding(),))
1443
1765
 
1444
1766
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
1445
1767
        self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
1450
1772
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1451
1773
        self.assertEqual('foo', old)
1452
1774
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1453
 
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
1454
 
 
1455
 
 
1456
 
class TestLocalTimeOffset(TestCase):
1457
 
 
1458
 
    def test_local_time_offset(self):
1459
 
        """Test that local_time_offset() returns a sane value."""
1460
 
        offset = osutils.local_time_offset()
1461
 
        self.assertTrue(isinstance(offset, int))
1462
 
        # Test that the offset is no more than a eighteen hours in
1463
 
        # either direction.
1464
 
        # Time zone handling is system specific, so it is difficult to
1465
 
        # do more specific tests, but a value outside of this range is
1466
 
        # probably wrong.
1467
 
        eighteen_hours = 18 * 3600
1468
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
1469
 
 
1470
 
    def test_local_time_offset_with_timestamp(self):
1471
 
        """Test that local_time_offset() works with a timestamp."""
1472
 
        offset = osutils.local_time_offset(1000000000.1234567)
1473
 
        self.assertTrue(isinstance(offset, int))
1474
 
        eighteen_hours = 18 * 3600
1475
 
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
1476
 
 
1477
 
 
1478
 
class TestSizeShaFile(TestCaseInTempDir):
 
1775
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
 
1776
 
 
1777
 
 
1778
class TestSizeShaFile(tests.TestCaseInTempDir):
1479
1779
 
1480
1780
    def test_sha_empty(self):
1481
1781
        self.build_tree_contents([('foo', '')])
1490
1790
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
1491
1791
        self.build_tree_contents([('foo', text)])
1492
1792
        expected_sha = osutils.sha_string(text)
1493
 
        f = open('foo')
 
1793
        f = open('foo', 'rb')
1494
1794
        self.addCleanup(f.close)
1495
1795
        size, sha = osutils.size_sha_file(f)
1496
1796
        self.assertEqual(38, size)
1497
1797
        self.assertEqual(expected_sha, sha)
1498
1798
 
1499
1799
 
1500
 
class TestShaFileByName(TestCaseInTempDir):
 
1800
class TestShaFileByName(tests.TestCaseInTempDir):
1501
1801
 
1502
1802
    def test_sha_empty(self):
1503
1803
        self.build_tree_contents([('foo', '')])
1511
1811
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1512
1812
 
1513
1813
 
1514
 
class TestResourceLoading(TestCaseInTempDir):
 
1814
class TestResourceLoading(tests.TestCaseInTempDir):
1515
1815
 
1516
1816
    def test_resource_string(self):
1517
1817
        # test resource in bzrlib
1527
1827
        self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
1528
1828
 
1529
1829
 
1530
 
class TestReCompile(TestCase):
 
1830
class TestReCompile(tests.TestCase):
 
1831
 
 
1832
    def _deprecated_re_compile_checked(self, *args, **kwargs):
 
1833
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
 
1834
            osutils.re_compile_checked, *args, **kwargs)
1531
1835
 
1532
1836
    def test_re_compile_checked(self):
1533
 
        r = osutils.re_compile_checked(r'A*', re.IGNORECASE)
 
1837
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1534
1838
        self.assertTrue(r.match('aaaa'))
1535
1839
        self.assertTrue(r.match('aAaA'))
1536
1840
 
1537
1841
    def test_re_compile_checked_error(self):
1538
1842
        # like https://bugs.launchpad.net/bzr/+bug/251352
 
1843
 
 
1844
        # Due to possible test isolation error, re.compile is not lazy at
 
1845
        # this point. We re-install lazy compile.
 
1846
        lazy_regex.install_lazy_compile()
1539
1847
        err = self.assertRaises(
1540
1848
            errors.BzrCommandError,
1541
 
            osutils.re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1849
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1542
1850
        self.assertEqual(
1543
 
            "Invalid regular expression in test case: '*': "
1544
 
            "nothing to repeat",
 
1851
            'Invalid regular expression in test case: '
 
1852
            '"*" nothing to repeat',
1545
1853
            str(err))
 
1854
 
 
1855
 
 
1856
class TestDirReader(tests.TestCaseInTempDir):
 
1857
 
 
1858
    scenarios = dir_reader_scenarios()
 
1859
 
 
1860
    # Set by load_tests
 
1861
    _dir_reader_class = None
 
1862
    _native_to_unicode = None
 
1863
 
 
1864
    def setUp(self):
 
1865
        super(TestDirReader, self).setUp()
 
1866
        self.overrideAttr(osutils,
 
1867
                          '_selected_dir_reader', self._dir_reader_class())
 
1868
 
 
1869
    def _get_ascii_tree(self):
 
1870
        tree = [
 
1871
            '0file',
 
1872
            '1dir/',
 
1873
            '1dir/0file',
 
1874
            '1dir/1dir/',
 
1875
            '2file'
 
1876
            ]
 
1877
        expected_dirblocks = [
 
1878
                (('', '.'),
 
1879
                 [('0file', '0file', 'file'),
 
1880
                  ('1dir', '1dir', 'directory'),
 
1881
                  ('2file', '2file', 'file'),
 
1882
                 ]
 
1883
                ),
 
1884
                (('1dir', './1dir'),
 
1885
                 [('1dir/0file', '0file', 'file'),
 
1886
                  ('1dir/1dir', '1dir', 'directory'),
 
1887
                 ]
 
1888
                ),
 
1889
                (('1dir/1dir', './1dir/1dir'),
 
1890
                 [
 
1891
                 ]
 
1892
                ),
 
1893
            ]
 
1894
        return tree, expected_dirblocks
 
1895
 
 
1896
    def test_walk_cur_dir(self):
 
1897
        tree, expected_dirblocks = self._get_ascii_tree()
 
1898
        self.build_tree(tree)
 
1899
        result = list(osutils._walkdirs_utf8('.'))
 
1900
        # Filter out stat and abspath
 
1901
        self.assertEqual(expected_dirblocks,
 
1902
                         [(dirinfo, [line[0:3] for line in block])
 
1903
                          for dirinfo, block in result])
 
1904
 
 
1905
    def test_walk_sub_dir(self):
 
1906
        tree, expected_dirblocks = self._get_ascii_tree()
 
1907
        self.build_tree(tree)
 
1908
        # you can search a subdir only, with a supplied prefix.
 
1909
        result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
 
1910
        # Filter out stat and abspath
 
1911
        self.assertEqual(expected_dirblocks[1:],
 
1912
                         [(dirinfo, [line[0:3] for line in block])
 
1913
                          for dirinfo, block in result])
 
1914
 
 
1915
    def _get_unicode_tree(self):
 
1916
        name0u = u'0file-\xb6'
 
1917
        name1u = u'1dir-\u062c\u0648'
 
1918
        name2u = u'2file-\u0633'
 
1919
        tree = [
 
1920
            name0u,
 
1921
            name1u + '/',
 
1922
            name1u + '/' + name0u,
 
1923
            name1u + '/' + name1u + '/',
 
1924
            name2u,
 
1925
            ]
 
1926
        name0 = name0u.encode('UTF-8')
 
1927
        name1 = name1u.encode('UTF-8')
 
1928
        name2 = name2u.encode('UTF-8')
 
1929
        expected_dirblocks = [
 
1930
                (('', '.'),
 
1931
                 [(name0, name0, 'file', './' + name0u),
 
1932
                  (name1, name1, 'directory', './' + name1u),
 
1933
                  (name2, name2, 'file', './' + name2u),
 
1934
                 ]
 
1935
                ),
 
1936
                ((name1, './' + name1u),
 
1937
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
 
1938
                                                        + '/' + name0u),
 
1939
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
 
1940
                                                            + '/' + name1u),
 
1941
                 ]
 
1942
                ),
 
1943
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
 
1944
                 [
 
1945
                 ]
 
1946
                ),
 
1947
            ]
 
1948
        return tree, expected_dirblocks
 
1949
 
 
1950
    def _filter_out(self, raw_dirblocks):
 
1951
        """Filter out a walkdirs_utf8 result.
 
1952
 
 
1953
        stat field is removed, all native paths are converted to unicode
 
1954
        """
 
1955
        filtered_dirblocks = []
 
1956
        for dirinfo, block in raw_dirblocks:
 
1957
            dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
 
1958
            details = []
 
1959
            for line in block:
 
1960
                details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
 
1961
            filtered_dirblocks.append((dirinfo, details))
 
1962
        return filtered_dirblocks
 
1963
 
 
1964
    def test_walk_unicode_tree(self):
 
1965
        self.requireFeature(features.UnicodeFilenameFeature)
 
1966
        tree, expected_dirblocks = self._get_unicode_tree()
 
1967
        self.build_tree(tree)
 
1968
        result = list(osutils._walkdirs_utf8('.'))
 
1969
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1970
 
 
1971
    def test_symlink(self):
 
1972
        self.requireFeature(features.SymlinkFeature)
 
1973
        self.requireFeature(features.UnicodeFilenameFeature)
 
1974
        target = u'target\N{Euro Sign}'
 
1975
        link_name = u'l\N{Euro Sign}nk'
 
1976
        os.symlink(target, link_name)
 
1977
        target_utf8 = target.encode('UTF-8')
 
1978
        link_name_utf8 = link_name.encode('UTF-8')
 
1979
        expected_dirblocks = [
 
1980
                (('', '.'),
 
1981
                 [(link_name_utf8, link_name_utf8,
 
1982
                   'symlink', './' + link_name),],
 
1983
                 )]
 
1984
        result = list(osutils._walkdirs_utf8('.'))
 
1985
        self.assertEqual(expected_dirblocks, self._filter_out(result))
 
1986
 
 
1987
 
 
1988
class TestReadLink(tests.TestCaseInTempDir):
 
1989
    """Exposes os.readlink() problems and the osutils solution.
 
1990
 
 
1991
    The only guarantee offered by os.readlink(), starting with 2.6, is that a
 
1992
    unicode string will be returned if a unicode string is passed.
 
1993
 
 
1994
    But prior python versions failed to properly encode the passed unicode
 
1995
    string.
 
1996
    """
 
1997
    _test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
 
1998
 
 
1999
    def setUp(self):
 
2000
        super(tests.TestCaseInTempDir, self).setUp()
 
2001
        self.link = u'l\N{Euro Sign}ink'
 
2002
        self.target = u'targe\N{Euro Sign}t'
 
2003
        os.symlink(self.target, self.link)
 
2004
 
 
2005
    def test_os_readlink_link_encoding(self):
 
2006
        self.assertEquals(self.target,  os.readlink(self.link))
 
2007
 
 
2008
    def test_os_readlink_link_decoding(self):
 
2009
        self.assertEquals(self.target.encode(osutils._fs_enc),
 
2010
                          os.readlink(self.link.encode(osutils._fs_enc)))
 
2011
 
 
2012
 
 
2013
class TestConcurrency(tests.TestCase):
 
2014
 
 
2015
    def setUp(self):
 
2016
        super(TestConcurrency, self).setUp()
 
2017
        self.overrideAttr(osutils, '_cached_local_concurrency')
 
2018
 
 
2019
    def test_local_concurrency(self):
 
2020
        concurrency = osutils.local_concurrency()
 
2021
        self.assertIsInstance(concurrency, int)
 
2022
 
 
2023
    def test_local_concurrency_environment_variable(self):
 
2024
        self.overrideEnv('BZR_CONCURRENCY', '2')
 
2025
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
 
2026
        self.overrideEnv('BZR_CONCURRENCY', '3')
 
2027
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
 
2028
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
 
2029
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
 
2030
 
 
2031
    def test_option_concurrency(self):
 
2032
        self.overrideEnv('BZR_CONCURRENCY', '1')
 
2033
        self.run_bzr('rocks --concurrency 42')
 
2034
        # Command line overrides environment variable
 
2035
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
 
2036
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
 
2037
 
 
2038
 
 
2039
class TestFailedToLoadExtension(tests.TestCase):
 
2040
 
 
2041
    def _try_loading(self):
 
2042
        try:
 
2043
            import bzrlib._fictional_extension_py
 
2044
        except ImportError, e:
 
2045
            osutils.failed_to_load_extension(e)
 
2046
            return True
 
2047
 
 
2048
    def setUp(self):
 
2049
        super(TestFailedToLoadExtension, self).setUp()
 
2050
        self.overrideAttr(osutils, '_extension_load_failures', [])
 
2051
 
 
2052
    def test_failure_to_load(self):
 
2053
        self._try_loading()
 
2054
        self.assertLength(1, osutils._extension_load_failures)
 
2055
        self.assertEquals(osutils._extension_load_failures[0],
 
2056
            "No module named _fictional_extension_py")
 
2057
 
 
2058
    def test_report_extension_load_failures_no_warning(self):
 
2059
        self.assertTrue(self._try_loading())
 
2060
        warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
 
2061
        # it used to give a Python warning; it no longer does
 
2062
        self.assertLength(0, warnings)
 
2063
 
 
2064
    def test_report_extension_load_failures_message(self):
 
2065
        log = StringIO()
 
2066
        trace.push_log_file(log)
 
2067
        self.assertTrue(self._try_loading())
 
2068
        osutils.report_extension_load_failures()
 
2069
        self.assertContainsRe(
 
2070
            log.getvalue(),
 
2071
            r"bzr: warning: some compiled extensions could not be loaded; "
 
2072
            "see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
 
2073
            )
 
2074
 
 
2075
 
 
2076
class TestTerminalWidth(tests.TestCase):
 
2077
 
 
2078
    def setUp(self):
 
2079
        super(TestTerminalWidth, self).setUp()
 
2080
        self._orig_terminal_size_state = osutils._terminal_size_state
 
2081
        self._orig_first_terminal_size = osutils._first_terminal_size
 
2082
        self.addCleanup(self.restore_osutils_globals)
 
2083
        osutils._terminal_size_state = 'no_data'
 
2084
        osutils._first_terminal_size = None
 
2085
 
 
2086
    def restore_osutils_globals(self):
 
2087
        osutils._terminal_size_state = self._orig_terminal_size_state
 
2088
        osutils._first_terminal_size = self._orig_first_terminal_size
 
2089
 
 
2090
    def replace_stdout(self, new):
 
2091
        self.overrideAttr(sys, 'stdout', new)
 
2092
 
 
2093
    def replace__terminal_size(self, new):
 
2094
        self.overrideAttr(osutils, '_terminal_size', new)
 
2095
 
 
2096
    def set_fake_tty(self):
 
2097
 
 
2098
        class I_am_a_tty(object):
 
2099
            def isatty(self):
 
2100
                return True
 
2101
 
 
2102
        self.replace_stdout(I_am_a_tty())
 
2103
 
 
2104
    def test_default_values(self):
 
2105
        self.assertEqual(80, osutils.default_terminal_width)
 
2106
 
 
2107
    def test_defaults_to_BZR_COLUMNS(self):
 
2108
        # BZR_COLUMNS is set by the test framework
 
2109
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
 
2110
        self.overrideEnv('BZR_COLUMNS', '12')
 
2111
        self.assertEqual(12, osutils.terminal_width())
 
2112
 
 
2113
    def test_BZR_COLUMNS_0_no_limit(self):
 
2114
        self.overrideEnv('BZR_COLUMNS', '0')
 
2115
        self.assertEqual(None, osutils.terminal_width())
 
2116
 
 
2117
    def test_falls_back_to_COLUMNS(self):
 
2118
        self.overrideEnv('BZR_COLUMNS', None)
 
2119
        self.assertNotEqual('42', os.environ['COLUMNS'])
 
2120
        self.set_fake_tty()
 
2121
        self.overrideEnv('COLUMNS', '42')
 
2122
        self.assertEqual(42, osutils.terminal_width())
 
2123
 
 
2124
    def test_tty_default_without_columns(self):
 
2125
        self.overrideEnv('BZR_COLUMNS', None)
 
2126
        self.overrideEnv('COLUMNS', None)
 
2127
 
 
2128
        def terminal_size(w, h):
 
2129
            return 42, 42
 
2130
 
 
2131
        self.set_fake_tty()
 
2132
        # We need to override the osutils definition as it depends on the
 
2133
        # running environment that we can't control (PQM running without a
 
2134
        # controlling terminal is one example).
 
2135
        self.replace__terminal_size(terminal_size)
 
2136
        self.assertEqual(42, osutils.terminal_width())
 
2137
 
 
2138
    def test_non_tty_default_without_columns(self):
 
2139
        self.overrideEnv('BZR_COLUMNS', None)
 
2140
        self.overrideEnv('COLUMNS', None)
 
2141
        self.replace_stdout(None)
 
2142
        self.assertEqual(None, osutils.terminal_width())
 
2143
 
 
2144
    def test_no_TIOCGWINSZ(self):
 
2145
        self.requireFeature(term_ios_feature)
 
2146
        termios = term_ios_feature.module
 
2147
        # bug 63539 is about a termios without TIOCGWINSZ attribute
 
2148
        try:
 
2149
            orig = termios.TIOCGWINSZ
 
2150
        except AttributeError:
 
2151
            # We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
 
2152
            pass
 
2153
        else:
 
2154
            self.overrideAttr(termios, 'TIOCGWINSZ')
 
2155
            del termios.TIOCGWINSZ
 
2156
        self.overrideEnv('BZR_COLUMNS', None)
 
2157
        self.overrideEnv('COLUMNS', None)
 
2158
        # Whatever the result is, if we don't raise an exception, it's ok.
 
2159
        osutils.terminal_width()
 
2160
 
 
2161
 
 
2162
class TestCreationOps(tests.TestCaseInTempDir):
 
2163
    _test_needs_features = [features.chown_feature]
 
2164
 
 
2165
    def setUp(self):
 
2166
        super(TestCreationOps, self).setUp()
 
2167
        self.overrideAttr(os, 'chown', self._dummy_chown)
 
2168
 
 
2169
        # params set by call to _dummy_chown
 
2170
        self.path = self.uid = self.gid = None
 
2171
 
 
2172
    def _dummy_chown(self, path, uid, gid):
 
2173
        self.path, self.uid, self.gid = path, uid, gid
 
2174
 
 
2175
    def test_copy_ownership_from_path(self):
 
2176
        """copy_ownership_from_path test with specified src."""
 
2177
        ownsrc = '/'
 
2178
        f = open('test_file', 'wt')
 
2179
        osutils.copy_ownership_from_path('test_file', ownsrc)
 
2180
 
 
2181
        s = os.stat(ownsrc)
 
2182
        self.assertEquals(self.path, 'test_file')
 
2183
        self.assertEquals(self.uid, s.st_uid)
 
2184
        self.assertEquals(self.gid, s.st_gid)
 
2185
 
 
2186
    def test_copy_ownership_nonesrc(self):
 
2187
        """copy_ownership_from_path test with src=None."""
 
2188
        f = open('test_file', 'wt')
 
2189
        # should use parent dir for permissions
 
2190
        osutils.copy_ownership_from_path('test_file')
 
2191
 
 
2192
        s = os.stat('..')
 
2193
        self.assertEquals(self.path, 'test_file')
 
2194
        self.assertEquals(self.uid, s.st_uid)
 
2195
        self.assertEquals(self.gid, s.st_gid)
 
2196
 
 
2197
 
 
2198
class TestPathFromEnviron(tests.TestCase):
 
2199
 
 
2200
    def test_is_unicode(self):
 
2201
        self.overrideEnv('BZR_TEST_PATH', './anywhere at all/')
 
2202
        path = osutils.path_from_environ('BZR_TEST_PATH')
 
2203
        self.assertIsInstance(path, unicode)
 
2204
        self.assertEqual(u'./anywhere at all/', path)
 
2205
 
 
2206
    def test_posix_path_env_ascii(self):
 
2207
        self.overrideEnv('BZR_TEST_PATH', '/tmp')
 
2208
        home = osutils._posix_path_from_environ('BZR_TEST_PATH')
 
2209
        self.assertIsInstance(home, unicode)
 
2210
        self.assertEqual(u'/tmp', home)
 
2211
 
 
2212
    def test_posix_path_env_unicode(self):
 
2213
        self.requireFeature(features.ByteStringNamedFilesystem)
 
2214
        self.overrideEnv('BZR_TEST_PATH', '/home/\xa7test')
 
2215
        self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
 
2216
        self.assertEqual(u'/home/\xa7test',
 
2217
            osutils._posix_path_from_environ('BZR_TEST_PATH'))
 
2218
        osutils._fs_enc = "iso8859-5"
 
2219
        self.assertEqual(u'/home/\u0407test',
 
2220
            osutils._posix_path_from_environ('BZR_TEST_PATH'))
 
2221
        osutils._fs_enc = "utf-8"
 
2222
        self.assertRaises(errors.BadFilenameEncoding,
 
2223
            osutils._posix_path_from_environ, 'BZR_TEST_PATH')
 
2224
 
 
2225
 
 
2226
class TestGetHomeDir(tests.TestCase):
 
2227
 
 
2228
    def test_is_unicode(self):
 
2229
        home = osutils._get_home_dir()
 
2230
        self.assertIsInstance(home, unicode)
 
2231
 
 
2232
    def test_posix_homeless(self):
 
2233
        self.overrideEnv('HOME', None)
 
2234
        home = osutils._get_home_dir()
 
2235
        self.assertIsInstance(home, unicode)
 
2236
 
 
2237
    def test_posix_home_ascii(self):
 
2238
        self.overrideEnv('HOME', '/home/test')
 
2239
        home = osutils._posix_get_home_dir()
 
2240
        self.assertIsInstance(home, unicode)
 
2241
        self.assertEqual(u'/home/test', home)
 
2242
 
 
2243
    def test_posix_home_unicode(self):
 
2244
        self.requireFeature(features.ByteStringNamedFilesystem)
 
2245
        self.overrideEnv('HOME', '/home/\xa7test')
 
2246
        self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
 
2247
        self.assertEqual(u'/home/\xa7test', osutils._posix_get_home_dir())
 
2248
        osutils._fs_enc = "iso8859-5"
 
2249
        self.assertEqual(u'/home/\u0407test', osutils._posix_get_home_dir())
 
2250
        osutils._fs_enc = "utf-8"
 
2251
        self.assertRaises(errors.BadFilenameEncoding,
 
2252
            osutils._posix_get_home_dir)
 
2253
 
 
2254
 
 
2255
class TestGetuserUnicode(tests.TestCase):
 
2256
 
 
2257
    def test_is_unicode(self):
 
2258
        user = osutils.getuser_unicode()
 
2259
        self.assertIsInstance(user, unicode)
 
2260
 
 
2261
    def envvar_to_override(self):
 
2262
        if sys.platform == "win32":
 
2263
            # Disable use of platform calls on windows so envvar is used
 
2264
            self.overrideAttr(win32utils, 'has_ctypes', False)
 
2265
            return 'USERNAME' # only variable used on windows
 
2266
        return 'LOGNAME' # first variable checked by getpass.getuser()
 
2267
 
 
2268
    def test_ascii_user(self):
 
2269
        self.overrideEnv(self.envvar_to_override(), 'jrandom')
 
2270
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
 
2271
 
 
2272
    def test_unicode_user(self):
 
2273
        ue = osutils.get_user_encoding()
 
2274
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
2275
        if uni_val is None:
 
2276
            raise tests.TestSkipped(
 
2277
                'Cannot find a unicode character that works in encoding %s'
 
2278
                % (osutils.get_user_encoding(),))
 
2279
        uni_username = u'jrandom' + uni_val
 
2280
        encoded_username = uni_username.encode(ue)
 
2281
        self.overrideEnv(self.envvar_to_override(), encoded_username)
 
2282
        self.assertEqual(uni_username, osutils.getuser_unicode())
 
2283
 
 
2284
 
 
2285
class TestBackupNames(tests.TestCase):
 
2286
 
 
2287
    def setUp(self):
 
2288
        super(TestBackupNames, self).setUp()
 
2289
        self.backups = []
 
2290
 
 
2291
    def backup_exists(self, name):
 
2292
        return name in self.backups
 
2293
 
 
2294
    def available_backup_name(self, name):
 
2295
        backup_name = osutils.available_backup_name(name, self.backup_exists)
 
2296
        self.backups.append(backup_name)
 
2297
        return backup_name
 
2298
 
 
2299
    def assertBackupName(self, expected, name):
 
2300
        self.assertEqual(expected, self.available_backup_name(name))
 
2301
 
 
2302
    def test_empty(self):
 
2303
        self.assertBackupName('file.~1~', 'file')
 
2304
 
 
2305
    def test_existing(self):
 
2306
        self.available_backup_name('file')
 
2307
        self.available_backup_name('file')
 
2308
        self.assertBackupName('file.~3~', 'file')
 
2309
        # Empty slots are found, this is not a strict requirement and may be
 
2310
        # revisited if we test against all implementations.
 
2311
        self.backups.remove('file.~2~')
 
2312
        self.assertBackupName('file.~2~', 'file')
 
2313
 
 
2314
 
 
2315
class TestFindExecutableInPath(tests.TestCase):
 
2316
 
 
2317
    def test_windows(self):
 
2318
        if sys.platform != 'win32':
 
2319
            raise tests.TestSkipped('test requires win32')
 
2320
        self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
 
2321
        self.assertTrue(
 
2322
            osutils.find_executable_on_path('explorer.exe') is not None)
 
2323
        self.assertTrue(
 
2324
            osutils.find_executable_on_path('EXPLORER.EXE') is not None)
 
2325
        self.assertTrue(
 
2326
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2327
        self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
 
2328
        
 
2329
    def test_windows_app_path(self):
 
2330
        if sys.platform != 'win32':
 
2331
            raise tests.TestSkipped('test requires win32')
 
2332
        # Override PATH env var so that exe can only be found on App Path
 
2333
        self.overrideEnv('PATH', '')
 
2334
        # Internt Explorer is always registered in the App Path
 
2335
        self.assertTrue(osutils.find_executable_on_path('iexplore') is not None)
 
2336
 
 
2337
    def test_other(self):
 
2338
        if sys.platform == 'win32':
 
2339
            raise tests.TestSkipped('test requires non-win32')
 
2340
        self.assertTrue(osutils.find_executable_on_path('sh') is not None)
 
2341
        self.assertTrue(
 
2342
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2343
 
 
2344
 
 
2345
class TestEnvironmentErrors(tests.TestCase):
 
2346
    """Test handling of environmental errors"""
 
2347
 
 
2348
    def test_is_oserror(self):
 
2349
        self.assertTrue(osutils.is_environment_error(
 
2350
            OSError(errno.EINVAL, "Invalid parameter")))
 
2351
 
 
2352
    def test_is_ioerror(self):
 
2353
        self.assertTrue(osutils.is_environment_error(
 
2354
            IOError(errno.EINVAL, "Invalid parameter")))
 
2355
 
 
2356
    def test_is_socket_error(self):
 
2357
        self.assertTrue(osutils.is_environment_error(
 
2358
            socket.error(errno.EINVAL, "Invalid parameter")))
 
2359
 
 
2360
    def test_is_select_error(self):
 
2361
        self.assertTrue(osutils.is_environment_error(
 
2362
            select.error(errno.EINVAL, "Invalid parameter")))
 
2363
 
 
2364
    def test_is_pywintypes_error(self):
 
2365
        self.requireFeature(features.pywintypes)
 
2366
        import pywintypes
 
2367
        self.assertTrue(osutils.is_environment_error(
 
2368
            pywintypes.error(errno.EINVAL, "Invalid parameter", "Caller")))