← 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: Lukáš Lalinský
  • Date: 2008-08-23 13:06:24 UTC
  • mto: (3650.1.1 bzr.ab.integration)
  • mto: This revision was merged to the branch mainline in revision 3651.
  • Revision ID: lalinsky@gmail.com-20080823130624-rvbasutb8urxkamy
Add a test

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_osutils.py
1
 
# Copyright (C) 2005-2016 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Tests for the osutils wrapper."""
18
18
 
19
19
from cStringIO import StringIO
20
20
import errno
21
21
import os
22
 
import re
23
 
import select
24
22
import socket
 
23
import stat
25
24
import sys
26
 
import tempfile
27
25
import time
28
26
 
 
27
import bzrlib
29
28
from bzrlib import (
30
29
    errors,
31
 
    lazy_regex,
32
30
    osutils,
33
 
    symbol_versioning,
34
31
    tests,
35
 
    trace,
36
32
    win32utils,
37
33
    )
 
34
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
 
35
from bzrlib.osutils import (
 
36
        is_inside_any,
 
37
        is_inside_or_parent_of_any,
 
38
        pathjoin,
 
39
        pumpfile,
 
40
        )
38
41
from bzrlib.tests import (
39
 
    features,
40
 
    file_utils,
41
 
    test__walkdirs_win32,
 
42
        probe_unicode_in_user_encoding,
 
43
        StringIOWrapper,
 
44
        SymlinkFeature,
 
45
        TestCase,
 
46
        TestCaseInTempDir,
 
47
        TestSkipped,
 
48
        )
 
49
from bzrlib.tests.file_utils import (
 
50
    FakeReadFile,
42
51
    )
43
 
from bzrlib.tests.scenarios import load_tests_apply_scenarios
44
 
 
45
 
 
46
 
class _UTF8DirReaderFeature(features.Feature):
47
 
 
48
 
    def _probe(self):
49
 
        try:
50
 
            from bzrlib import _readdir_pyx
51
 
            self.reader = _readdir_pyx.UTF8DirReader
52
 
            return True
53
 
        except ImportError:
54
 
            return False
55
 
 
56
 
    def feature_name(self):
57
 
        return 'bzrlib._readdir_pyx'
58
 
 
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):
 
52
from bzrlib.tests.test__walkdirs_win32 import WalkdirsWin32Feature
 
53
 
 
54
 
 
55
class TestOSUtils(TestCaseInTempDir):
106
56
 
107
57
    def test_contains_whitespace(self):
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'))
 
58
        self.failUnless(osutils.contains_whitespace(u' '))
 
59
        self.failUnless(osutils.contains_whitespace(u'hello there'))
 
60
        self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
 
61
        self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
 
62
        self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
 
63
        self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
114
64
 
115
65
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
116
66
        # is whitespace, but we do not.
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)
 
67
        self.failIf(osutils.contains_whitespace(u''))
 
68
        self.failIf(osutils.contains_whitespace(u'hellothere'))
 
69
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
134
70
 
135
71
    def test_fancy_rename(self):
136
72
        # This should work everywhere
137
 
        self.create_file('a', 'something in a\n')
138
 
        self._fancy_rename('a', 'b')
139
 
        self.assertPathDoesNotExist('a')
140
 
        self.assertPathExists('b')
 
73
        def rename(a, b):
 
74
            osutils.fancy_rename(a, b,
 
75
                    rename_func=os.rename,
 
76
                    unlink_func=os.unlink)
 
77
 
 
78
        open('a', 'wb').write('something in a\n')
 
79
        rename('a', 'b')
 
80
        self.failIfExists('a')
 
81
        self.failUnlessExists('b')
141
82
        self.check_file_contents('b', 'something in a\n')
142
83
 
143
 
        self.create_file('a', 'new something in a\n')
144
 
        self._fancy_rename('b', 'a')
 
84
        open('a', 'wb').write('new something in a\n')
 
85
        rename('b', 'a')
145
86
 
146
87
        self.check_file_contents('a', 'something in a\n')
147
88
 
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
 
 
160
89
    def test_rename(self):
161
90
        # Rename should be semi-atomic on all platforms
162
 
        self.create_file('a', 'something in a\n')
 
91
        open('a', 'wb').write('something in a\n')
163
92
        osutils.rename('a', 'b')
164
 
        self.assertPathDoesNotExist('a')
165
 
        self.assertPathExists('b')
 
93
        self.failIfExists('a')
 
94
        self.failUnlessExists('b')
166
95
        self.check_file_contents('b', 'something in a\n')
167
96
 
168
 
        self.create_file('a', 'new something in a\n')
 
97
        open('a', 'wb').write('new something in a\n')
169
98
        osutils.rename('b', 'a')
170
99
 
171
100
        self.check_file_contents('a', 'something in a\n')
180
109
        # we can't use failUnlessExists on case-insensitive filesystem
181
110
        # so try to check shape of the tree
182
111
        shape = sorted(os.listdir('.'))
183
 
        self.assertEqual(['A', 'B'], shape)
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):
 
112
        self.assertEquals(['A', 'B'], shape)
196
113
 
197
114
    def test_01_rand_chars_empty(self):
198
115
        result = osutils.rand_chars(0)
204
121
        self.assertEqual(type(result), str)
205
122
        self.assertContainsRe(result, r'^[a-z0-9]{100}$')
206
123
 
207
 
 
208
 
class TestIsInside(tests.TestCase):
209
 
 
210
124
    def test_is_inside(self):
211
125
        is_inside = osutils.is_inside
212
126
        self.assertTrue(is_inside('src', 'src/foo.c'))
217
131
        self.assertTrue(is_inside('', 'foo.c'))
218
132
 
219
133
    def test_is_inside_any(self):
220
 
        SRC_FOO_C = osutils.pathjoin('src', 'foo.c')
 
134
        SRC_FOO_C = pathjoin('src', 'foo.c')
221
135
        for dirs, fn in [(['src', 'doc'], SRC_FOO_C),
222
136
                         (['src'], SRC_FOO_C),
223
137
                         (['src'], 'src'),
224
138
                         ]:
225
 
            self.assertTrue(osutils.is_inside_any(dirs, fn))
 
139
            self.assert_(is_inside_any(dirs, fn))
226
140
        for dirs, fn in [(['src'], 'srccontrol'),
227
141
                         (['src'], 'srccontrol/foo')]:
228
 
            self.assertFalse(osutils.is_inside_any(dirs, fn))
 
142
            self.assertFalse(is_inside_any(dirs, fn))
229
143
 
230
144
    def test_is_inside_or_parent_of_any(self):
231
145
        for dirs, fn in [(['src', 'doc'], 'src/foo.c'),
234
148
                         (['src/bar.c', 'bla/foo.c'], 'src'),
235
149
                         (['src'], 'src'),
236
150
                         ]:
237
 
            self.assertTrue(osutils.is_inside_or_parent_of_any(dirs, fn))
238
 
 
 
151
            self.assert_(is_inside_or_parent_of_any(dirs, fn))
 
152
            
239
153
        for dirs, fn in [(['src'], 'srccontrol'),
240
154
                         (['srccontrol/foo.c'], 'src'),
241
155
                         (['src'], 'srccontrol/foo')]:
242
 
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
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):
 
156
            self.assertFalse(is_inside_or_parent_of_any(dirs, fn))
265
157
 
266
158
    def test_rmtree(self):
267
159
        # Check to remove tree with read-only files/dirs
278
170
 
279
171
        osutils.rmtree('dir')
280
172
 
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):
 
173
        self.failIfExists('dir/file')
 
174
        self.failIfExists('dir')
298
175
 
299
176
    def test_file_kind(self):
300
177
        self.build_tree(['file', 'dir/'])
301
 
        self.assertEqual('file', osutils.file_kind('file'))
302
 
        self.assertEqual('directory', osutils.file_kind('dir/'))
 
178
        self.assertEquals('file', osutils.file_kind('file'))
 
179
        self.assertEquals('directory', osutils.file_kind('dir/'))
303
180
        if osutils.has_symlinks():
304
181
            os.symlink('symlink', 'symlink')
305
 
            self.assertEqual('symlink', osutils.file_kind('symlink'))
306
 
 
 
182
            self.assertEquals('symlink', osutils.file_kind('symlink'))
 
183
        
307
184
        # TODO: jam 20060529 Test a block device
308
185
        try:
309
186
            os.lstat('/dev/null')
311
188
            if e.errno not in (errno.ENOENT,):
312
189
                raise
313
190
        else:
314
 
            self.assertEqual('chardev', osutils.file_kind('/dev/null'))
 
191
            self.assertEquals('chardev', osutils.file_kind('/dev/null'))
315
192
 
316
193
        mkfifo = getattr(os, 'mkfifo', None)
317
194
        if mkfifo:
318
195
            mkfifo('fifo')
319
196
            try:
320
 
                self.assertEqual('fifo', osutils.file_kind('fifo'))
 
197
                self.assertEquals('fifo', osutils.file_kind('fifo'))
321
198
            finally:
322
199
                os.remove('fifo')
323
200
 
326
203
            s = socket.socket(AF_UNIX)
327
204
            s.bind('socket')
328
205
            try:
329
 
                self.assertEqual('socket', osutils.file_kind('socket'))
 
206
                self.assertEquals('socket', osutils.file_kind('socket'))
330
207
            finally:
331
208
                os.remove('socket')
332
209
 
333
210
    def test_kind_marker(self):
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):
 
211
        self.assertEqual(osutils.kind_marker('file'), '')
 
212
        self.assertEqual(osutils.kind_marker('directory'), '/')
 
213
        self.assertEqual(osutils.kind_marker('symlink'), '@')
 
214
        self.assertEqual(osutils.kind_marker('tree-reference'), '+')
345
215
 
346
216
    def test_get_umask(self):
347
217
        if sys.platform == 'win32':
350
220
            return
351
221
 
352
222
        orig_umask = osutils.get_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):
 
223
        try:
 
224
            os.umask(0222)
 
225
            self.assertEqual(0222, osutils.get_umask())
 
226
            os.umask(0022)
 
227
            self.assertEqual(0022, osutils.get_umask())
 
228
            os.umask(0002)
 
229
            self.assertEqual(0002, osutils.get_umask())
 
230
            os.umask(0027)
 
231
            self.assertEqual(0027, osutils.get_umask())
 
232
        finally:
 
233
            os.umask(orig_umask)
365
234
 
366
235
    def assertFormatedDelta(self, expected, seconds):
367
236
        """Assert osutils.format_delta formats as expected"""
402
271
    def test_format_date(self):
403
272
        self.assertRaises(errors.UnsupportedTimezoneFormat,
404
273
            osutils.format_date, 0, timezone='foo')
405
 
        self.assertIsInstance(osutils.format_date(0), str)
406
 
        self.assertIsInstance(osutils.format_local_date(0), unicode)
407
 
        # Testing for the actual value of the local weekday without
408
 
        # duplicating the code from format_date is difficult.
409
 
        # Instead blackbox.test_locale should check for localized
410
 
        # dates once they do occur in output strings.
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
274
 
485
275
    def test_dereference_path(self):
486
 
        self.requireFeature(features.SymlinkFeature)
 
276
        self.requireFeature(SymlinkFeature)
487
277
        cwd = osutils.realpath('.')
488
278
        os.mkdir('bar')
489
279
        bar_path = osutils.pathjoin(cwd, 'bar')
492
282
        self.assertEqual(bar_path, osutils.realpath('./bar'))
493
283
        os.symlink('bar', 'foo')
494
284
        self.assertEqual(bar_path, osutils.realpath('./foo'))
495
 
 
 
285
        
496
286
        # Does not dereference terminal symlinks
497
287
        foo_path = osutils.pathjoin(cwd, 'foo')
498
288
        self.assertEqual(foo_path, osutils.dereference_path('./foo'))
530
320
            osutils.make_readonly('dangling')
531
321
            osutils.make_writable('dangling')
532
322
 
 
323
    def test_kind_marker(self):
 
324
        self.assertEqual("", osutils.kind_marker("file"))
 
325
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
 
326
        self.assertEqual("@", osutils.kind_marker("symlink"))
 
327
        self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
 
328
 
533
329
    def test_host_os_dereferences_symlinks(self):
534
330
        osutils.host_os_dereferences_symlinks()
535
331
 
536
332
 
537
 
class TestCanonicalRelPath(tests.TestCaseInTempDir):
538
 
 
539
 
    _test_needs_features = [features.CaseInsCasePresFilenameFeature]
540
 
 
541
 
    def test_canonical_relpath_simple(self):
542
 
        f = file('MixedCaseName', 'w')
543
 
        f.close()
544
 
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
545
 
        self.assertEqual('work/MixedCaseName', actual)
546
 
 
547
 
    def test_canonical_relpath_missing_tail(self):
548
 
        os.mkdir('MixedCaseParent')
549
 
        actual = osutils.canonical_relpath(self.test_base_dir,
550
 
                                           'mixedcaseparent/nochild')
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):
 
333
class TestPumpFile(TestCase):
598
334
    """Test pumpfile method."""
599
 
 
600
335
    def setUp(self):
601
 
        super(TestPumpFile, self).setUp()
602
336
        # create a test datablock
603
337
        self.block_size = 512
604
338
        pattern = '0123456789ABCDEF'
611
345
        # make sure test data is larger than max read size
612
346
        self.assertTrue(self.test_data_len > self.block_size)
613
347
 
614
 
        from_file = file_utils.FakeReadFile(self.test_data)
 
348
        from_file = FakeReadFile(self.test_data)
615
349
        to_file = StringIO()
616
350
 
617
351
        # read (max / 2) bytes and verify read size wasn't affected
618
352
        num_bytes_to_read = self.block_size / 2
619
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
353
        pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
620
354
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
621
355
        self.assertEqual(from_file.get_read_count(), 1)
622
356
 
623
357
        # read (max) bytes and verify read size wasn't affected
624
358
        num_bytes_to_read = self.block_size
625
359
        from_file.reset_read_count()
626
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
360
        pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
627
361
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
628
362
        self.assertEqual(from_file.get_read_count(), 1)
629
363
 
630
364
        # read (max + 1) bytes and verify read size was limited
631
365
        num_bytes_to_read = self.block_size + 1
632
366
        from_file.reset_read_count()
633
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
367
        pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
634
368
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
635
369
        self.assertEqual(from_file.get_read_count(), 2)
636
370
 
637
371
        # finish reading the rest of the data
638
372
        num_bytes_to_read = self.test_data_len - to_file.tell()
639
 
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
 
373
        pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
640
374
 
641
375
        # report error if the data wasn't equal (we only report the size due
642
376
        # to the length of the data)
652
386
        self.assertTrue(self.test_data_len > self.block_size)
653
387
 
654
388
        # retrieve data in blocks
655
 
        from_file = file_utils.FakeReadFile(self.test_data)
 
389
        from_file = FakeReadFile(self.test_data)
656
390
        to_file = StringIO()
657
 
        osutils.pumpfile(from_file, to_file, self.test_data_len,
658
 
                         self.block_size)
 
391
        pumpfile(from_file, to_file, self.test_data_len, self.block_size)
659
392
 
660
393
        # verify read size was equal to the maximum read size
661
394
        self.assertTrue(from_file.get_max_read_size() > 0)
676
409
        self.assertTrue(self.test_data_len > self.block_size)
677
410
 
678
411
        # retrieve data to EOF
679
 
        from_file = file_utils.FakeReadFile(self.test_data)
 
412
        from_file = FakeReadFile(self.test_data)
680
413
        to_file = StringIO()
681
 
        osutils.pumpfile(from_file, to_file, -1, self.block_size)
 
414
        pumpfile(from_file, to_file, -1, self.block_size)
682
415
 
683
416
        # verify read size was equal to the maximum read size
684
417
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
696
429
        test verifies that any existing usages of pumpfile will not be broken
697
430
        with this new version."""
698
431
        # retrieve data using default (old) pumpfile method
699
 
        from_file = file_utils.FakeReadFile(self.test_data)
 
432
        from_file = FakeReadFile(self.test_data)
700
433
        to_file = StringIO()
701
 
        osutils.pumpfile(from_file, to_file)
 
434
        pumpfile(from_file, to_file)
702
435
 
703
436
        # report error if the data wasn't equal (we only report the size due
704
437
        # to the length of the data)
707
440
            message = "Data not equal.  Expected %d bytes, received %d."
708
441
            self.fail(message % (len(response_data), self.test_data_len))
709
442
 
710
 
    def test_report_activity(self):
711
 
        activity = []
712
 
        def log_activity(length, direction):
713
 
            activity.append((length, direction))
714
 
        from_file = StringIO(self.test_data)
715
 
        to_file = StringIO()
716
 
        osutils.pumpfile(from_file, to_file, buff_size=500,
717
 
                         report_activity=log_activity, direction='read')
718
 
        self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
719
 
                          (36, 'read')], activity)
720
 
 
721
 
        from_file = StringIO(self.test_data)
722
 
        to_file = StringIO()
723
 
        del activity[:]
724
 
        osutils.pumpfile(from_file, to_file, buff_size=500,
725
 
                         report_activity=log_activity, direction='write')
726
 
        self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
727
 
                          (36, 'write')], activity)
728
 
 
729
 
        # And with a limited amount of data
730
 
        from_file = StringIO(self.test_data)
731
 
        to_file = StringIO()
732
 
        del activity[:]
733
 
        osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
734
 
                         report_activity=log_activity, direction='read')
735
 
        self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
736
 
 
737
 
 
738
 
 
739
 
class TestPumpStringFile(tests.TestCase):
740
 
 
741
 
    def test_empty(self):
742
 
        output = StringIO()
743
 
        osutils.pump_string_file("", output)
744
 
        self.assertEqual("", output.getvalue())
745
 
 
746
 
    def test_more_than_segment_size(self):
747
 
        output = StringIO()
748
 
        osutils.pump_string_file("123456789", output, 2)
749
 
        self.assertEqual("123456789", output.getvalue())
750
 
 
751
 
    def test_segment_size(self):
752
 
        output = StringIO()
753
 
        osutils.pump_string_file("12", output, 2)
754
 
        self.assertEqual("12", output.getvalue())
755
 
 
756
 
    def test_segment_size_multiple(self):
757
 
        output = StringIO()
758
 
        osutils.pump_string_file("1234", output, 2)
759
 
        self.assertEqual("1234", output.getvalue())
760
 
 
761
 
 
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):
 
443
class TestSafeUnicode(TestCase):
782
444
 
783
445
    def test_from_ascii_string(self):
784
446
        self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
793
455
        self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
794
456
 
795
457
    def test_bad_utf8_string(self):
796
 
        self.assertRaises(errors.BzrBadParameterNotUnicode,
 
458
        self.assertRaises(BzrBadParameterNotUnicode,
797
459
                          osutils.safe_unicode,
798
460
                          '\xbb\xbb')
799
461
 
800
462
 
801
 
class TestSafeUtf8(tests.TestCase):
 
463
class TestSafeUtf8(TestCase):
802
464
 
803
465
    def test_from_ascii_string(self):
804
466
        f = 'foobar'
814
476
        self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
815
477
 
816
478
    def test_bad_utf8_string(self):
817
 
        self.assertRaises(errors.BzrBadParameterNotUnicode,
 
479
        self.assertRaises(BzrBadParameterNotUnicode,
818
480
                          osutils.safe_utf8, '\xbb\xbb')
819
481
 
820
482
 
821
 
class TestSafeRevisionId(tests.TestCase):
 
483
class TestSafeRevisionId(TestCase):
822
484
 
823
485
    def test_from_ascii_string(self):
824
486
        # this shouldn't give a warning because it's getting an ascii string
846
508
        self.assertEqual(None, osutils.safe_revision_id(None))
847
509
 
848
510
 
849
 
class TestSafeFileId(tests.TestCase):
 
511
class TestSafeFileId(TestCase):
850
512
 
851
513
    def test_from_ascii_string(self):
852
514
        self.assertEqual('foobar', osutils.safe_file_id('foobar'))
872
534
        self.assertEqual(None, osutils.safe_file_id(None))
873
535
 
874
536
 
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."""
 
537
class TestWin32Funcs(TestCase):
 
538
    """Test that the _win32 versions of os utilities return appropriate paths."""
926
539
 
927
540
    def test_abspath(self):
928
 
        self.requireFeature(features.win32_feature)
929
541
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
930
542
        self.assertEqual('C:/foo', osutils._win32_abspath('C:/foo'))
931
543
        self.assertEqual('//HOST/path', osutils._win32_abspath(r'\\HOST\path'))
936
548
        self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
937
549
 
938
550
    def test_pathjoin(self):
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'))
 
551
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path', 'to', 'foo'))
 
552
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path\\to', 'C:\\foo'))
 
553
        self.assertEqual('C:/foo', osutils._win32_pathjoin('path/to', 'C:/foo'))
 
554
        self.assertEqual('path/to/foo', osutils._win32_pathjoin('path/to/', 'foo'))
 
555
        self.assertEqual('/foo', osutils._win32_pathjoin('C:/path/to/', '/foo'))
 
556
        self.assertEqual('/foo', osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
957
557
 
958
558
    def test_normpath(self):
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'))
 
559
        self.assertEqual('path/to/foo', osutils._win32_normpath(r'path\\from\..\to\.\foo'))
 
560
        self.assertEqual('path/to/foo', osutils._win32_normpath('path//from/../to/./foo'))
963
561
 
964
562
    def test_getcwd(self):
965
563
        cwd = osutils._win32_getcwd()
978
576
        self.assertEqual('C:\\foo', osutils._win32_fixdrive('c:\\foo'))
979
577
 
980
578
    def test_win98_abspath(self):
981
 
        self.requireFeature(features.win32_feature)
982
579
        # absolute path
983
580
        self.assertEqual('C:/foo', osutils._win98_abspath('C:\\foo'))
984
581
        self.assertEqual('C:/foo', osutils._win98_abspath('C:/foo'))
987
584
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
988
585
        # relative path
989
586
        cwd = osutils.getcwd().rstrip('/')
990
 
        drive = osutils.ntpath.splitdrive(cwd)[0]
 
587
        drive = osutils._nt_splitdrive(cwd)[0]
991
588
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
992
589
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
993
590
        # unicode path
995
592
        self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
996
593
 
997
594
 
998
 
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
 
595
class TestWin32FuncsDirs(TestCaseInTempDir):
999
596
    """Test win32 functions that create files."""
 
597
    
 
598
    def test_getcwd(self):
 
599
        if win32utils.winver == 'Windows 98':
 
600
            raise TestSkipped('Windows 98 cannot handle unicode filenames')
 
601
        # Make sure getcwd can handle unicode filenames
 
602
        try:
 
603
            os.mkdir(u'mu-\xb5')
 
604
        except UnicodeError:
 
605
            raise TestSkipped("Unable to create Unicode filename")
1000
606
 
1001
 
    def test_getcwd(self):
1002
 
        self.requireFeature(features.UnicodeFilenameFeature)
1003
 
        os.mkdir(u'mu-\xb5')
1004
607
        os.chdir(u'mu-\xb5')
1005
608
        # TODO: jam 20060427 This will probably fail on Mac OSX because
1006
609
        #       it will change the normalization of B\xe5gfors
1011
614
    def test_minimum_path_selection(self):
1012
615
        self.assertEqual(set(),
1013
616
            osutils.minimum_path_selection([]))
1014
 
        self.assertEqual(set(['a']),
1015
 
            osutils.minimum_path_selection(['a']))
1016
617
        self.assertEqual(set(['a', 'b']),
1017
618
            osutils.minimum_path_selection(['a', 'b']))
1018
619
        self.assertEqual(set(['a/', 'b']),
1019
620
            osutils.minimum_path_selection(['a/', 'b']))
1020
621
        self.assertEqual(set(['a/', 'b']),
1021
622
            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']))
1024
623
 
1025
624
    def test_mkdtemp(self):
1026
625
        tmpdir = osutils._win32_mkdtemp(dir='.')
1035
634
        b.close()
1036
635
 
1037
636
        osutils._win32_rename('b', 'a')
1038
 
        self.assertPathExists('a')
1039
 
        self.assertPathDoesNotExist('b')
 
637
        self.failUnlessExists('a')
 
638
        self.failIfExists('b')
1040
639
        self.assertFileEqual('baz\n', 'a')
1041
640
 
1042
641
    def test_rename_missing_file(self):
1082
681
        self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
1083
682
 
1084
683
 
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):
 
684
class TestMacFuncsDirs(TestCaseInTempDir):
1095
685
    """Test mac special functions that require directories."""
1096
686
 
1097
687
    def test_getcwd(self):
1098
 
        self.requireFeature(features.UnicodeFilenameFeature)
1099
 
        os.mkdir(u'B\xe5gfors')
 
688
        # On Mac, this will actually create Ba\u030agfors
 
689
        # but chdir will still work, because it accepts both paths
 
690
        try:
 
691
            os.mkdir(u'B\xe5gfors')
 
692
        except UnicodeError:
 
693
            raise TestSkipped("Unable to create Unicode filename")
 
694
 
1100
695
        os.chdir(u'B\xe5gfors')
1101
696
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
1102
697
 
1103
698
    def test_getcwd_nonnorm(self):
1104
 
        self.requireFeature(features.UnicodeFilenameFeature)
1105
699
        # Test that _mac_getcwd() will normalize this path
1106
 
        os.mkdir(u'Ba\u030agfors')
 
700
        try:
 
701
            os.mkdir(u'Ba\u030agfors')
 
702
        except UnicodeError:
 
703
            raise TestSkipped("Unable to create Unicode filename")
 
704
 
1107
705
        os.chdir(u'Ba\u030agfors')
1108
706
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
1109
707
 
1110
708
 
1111
 
class TestChunksToLines(tests.TestCase):
1112
 
 
1113
 
    def test_smoketest(self):
1114
 
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
1115
 
                         osutils.chunks_to_lines(['foo\nbar', '\nbaz\n']))
1116
 
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
1117
 
                         osutils.chunks_to_lines(['foo\n', 'bar\n', 'baz\n']))
1118
 
 
1119
 
    def test_osutils_binding(self):
1120
 
        from bzrlib.tests import test__chunks_to_lines
1121
 
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
1122
 
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1123
 
        else:
1124
 
            from bzrlib._chunks_to_lines_py import chunks_to_lines
1125
 
        self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
1126
 
 
1127
 
 
1128
 
class TestSplitLines(tests.TestCase):
 
709
class TestSplitLines(TestCase):
1129
710
 
1130
711
    def test_split_unicode(self):
1131
712
        self.assertEqual([u'foo\n', u'bar\xae'],
1138
719
                         osutils.split_lines('foo\rbar\n'))
1139
720
 
1140
721
 
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])
 
722
class TestWalkDirs(TestCaseInTempDir):
1147
723
 
1148
724
    def test_walkdirs(self):
1149
725
        tree = [
1182
758
            result.append((dirdetail, dirblock))
1183
759
 
1184
760
        self.assertTrue(found_bzrdir)
1185
 
        self.assertExpectedBlocks(expected_dirblocks, result)
 
761
        self.assertEqual(expected_dirblocks,
 
762
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1186
763
        # you can search a subdir only, with a supplied prefix.
1187
764
        result = []
1188
765
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
1189
766
            result.append(dirblock)
1190
 
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
1191
 
 
1192
 
    def test_walkdirs_os_error(self):
1193
 
        # <https://bugs.launchpad.net/bzr/+bug/338653>
1194
 
        # Pyrex readdir didn't raise useful messages if it had an error
1195
 
        # reading the directory
1196
 
        if sys.platform == 'win32':
1197
 
            raise tests.TestNotApplicable(
1198
 
                "readdir IOError not tested on win32")
1199
 
        self.requireFeature(features.not_running_as_root)
1200
 
        os.mkdir("test-unreadable")
1201
 
        os.chmod("test-unreadable", 0000)
1202
 
        # must chmod it back so that it can be removed
1203
 
        self.addCleanup(os.chmod, "test-unreadable", 0700)
1204
 
        # The error is not raised until the generator is actually evaluated.
1205
 
        # (It would be ok if it happened earlier but at the moment it
1206
 
        # doesn't.)
1207
 
        e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
1208
 
        self.assertEqual('./test-unreadable', e.filename)
1209
 
        self.assertEqual(errno.EACCES, e.errno)
1210
 
        # Ensure the message contains the file name
1211
 
        self.assertContainsRe(str(e), "\./test-unreadable")
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)
 
767
        self.assertEqual(expected_dirblocks[1:],
 
768
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1248
769
 
1249
770
    def test__walkdirs_utf8(self):
1250
771
        tree = [
1283
804
            result.append((dirdetail, dirblock))
1284
805
 
1285
806
        self.assertTrue(found_bzrdir)
1286
 
        self.assertExpectedBlocks(expected_dirblocks, result)
1287
 
 
 
807
        self.assertEqual(expected_dirblocks,
 
808
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1288
809
        # you can search a subdir only, with a supplied prefix.
1289
810
        result = []
1290
811
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
1291
812
            result.append(dirblock)
1292
 
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
 
813
        self.assertEqual(expected_dirblocks[1:],
 
814
            [(dirinfo, [line[0:3] for line in block]) for dirinfo, block in result])
1293
815
 
1294
816
    def _filter_out_stat(self, result):
1295
817
        """Filter out the stat value from the walkdirs result"""
1300
822
                new_dirblock.append((info[0], info[1], info[2], info[4]))
1301
823
            dirblock[:] = new_dirblock
1302
824
 
 
825
    def test__walkdirs_utf8_selection(self):
 
826
        # Just trigger the function once, to make sure it has selected a real
 
827
        # implementation.
 
828
        list(osutils._walkdirs_utf8('.'))
 
829
        if WalkdirsWin32Feature.available():
 
830
            # If the compiled form is available, make sure it is used
 
831
            from bzrlib._walkdirs_win32 import _walkdirs_utf8_win32_find_file
 
832
            self.assertIs(_walkdirs_utf8_win32_find_file,
 
833
                          osutils._real_walkdirs_utf8)
 
834
        elif sys.platform == 'win32':
 
835
            self.assertIs(osutils._walkdirs_unicode_to_utf8,
 
836
                          osutils._real_walkdirs_utf8)
 
837
        elif osutils._fs_enc.upper() in ('UTF-8', 'ASCII', 'ANSI_X3.4-1968'): # ascii
 
838
            self.assertIs(osutils._walkdirs_fs_utf8,
 
839
                          osutils._real_walkdirs_utf8)
 
840
        else:
 
841
            self.assertIs(osutils._walkdirs_unicode_to_utf8,
 
842
                          osutils._real_walkdirs_utf8)
 
843
 
1303
844
    def _save_platform_info(self):
1304
 
        self.overrideAttr(win32utils, 'winver')
1305
 
        self.overrideAttr(osutils, '_fs_enc')
1306
 
        self.overrideAttr(osutils, '_selected_dir_reader')
 
845
        cur_winver = win32utils.winver
 
846
        cur_fs_enc = osutils._fs_enc
 
847
        cur_real_walkdirs_utf8 = osutils._real_walkdirs_utf8
 
848
        def restore():
 
849
            win32utils.winver = cur_winver
 
850
            osutils._fs_enc = cur_fs_enc
 
851
            osutils._real_walkdirs_utf8 = cur_real_walkdirs_utf8
 
852
        self.addCleanup(restore)
1307
853
 
1308
 
    def assertDirReaderIs(self, expected):
 
854
    def assertWalkdirsUtf8Is(self, expected):
1309
855
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
1310
856
        # Force it to redetect
1311
 
        osutils._selected_dir_reader = None
 
857
        osutils._real_walkdirs_utf8 = None
1312
858
        # Nothing to list, but should still trigger the selection logic
1313
859
        self.assertEqual([(('', '.'), [])], list(osutils._walkdirs_utf8('.')))
1314
 
        self.assertIsInstance(osutils._selected_dir_reader, expected)
 
860
        self.assertIs(expected, osutils._real_walkdirs_utf8)
1315
861
 
1316
862
    def test_force_walkdirs_utf8_fs_utf8(self):
1317
 
        self.requireFeature(UTF8DirReaderFeature)
1318
863
        self._save_platform_info()
1319
864
        win32utils.winver = None # Avoid the win32 detection code
1320
 
        osutils._fs_enc = 'utf-8'
1321
 
        self.assertDirReaderIs(
1322
 
            UTF8DirReaderFeature.module.UTF8DirReader)
 
865
        osutils._fs_enc = 'UTF-8'
 
866
        self.assertWalkdirsUtf8Is(osutils._walkdirs_fs_utf8)
1323
867
 
1324
868
    def test_force_walkdirs_utf8_fs_ascii(self):
1325
 
        self.requireFeature(UTF8DirReaderFeature)
1326
 
        self._save_platform_info()
1327
 
        win32utils.winver = None # Avoid the win32 detection code
1328
 
        osutils._fs_enc = 'ascii'
1329
 
        self.assertDirReaderIs(
1330
 
            UTF8DirReaderFeature.module.UTF8DirReader)
 
869
        self._save_platform_info()
 
870
        win32utils.winver = None # Avoid the win32 detection code
 
871
        osutils._fs_enc = 'US-ASCII'
 
872
        self.assertWalkdirsUtf8Is(osutils._walkdirs_fs_utf8)
 
873
 
 
874
    def test_force_walkdirs_utf8_fs_ANSI(self):
 
875
        self._save_platform_info()
 
876
        win32utils.winver = None # Avoid the win32 detection code
 
877
        osutils._fs_enc = 'ANSI_X3.4-1968'
 
878
        self.assertWalkdirsUtf8Is(osutils._walkdirs_fs_utf8)
1331
879
 
1332
880
    def test_force_walkdirs_utf8_fs_latin1(self):
1333
881
        self._save_platform_info()
1334
882
        win32utils.winver = None # Avoid the win32 detection code
1335
 
        osutils._fs_enc = 'iso-8859-1'
1336
 
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
883
        osutils._fs_enc = 'latin1'
 
884
        self.assertWalkdirsUtf8Is(osutils._walkdirs_unicode_to_utf8)
1337
885
 
1338
886
    def test_force_walkdirs_utf8_nt(self):
1339
 
        # Disabled because the thunk of the whole walkdirs api is disabled.
1340
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
887
        self.requireFeature(WalkdirsWin32Feature)
1341
888
        self._save_platform_info()
1342
889
        win32utils.winver = 'Windows NT'
1343
 
        from bzrlib._walkdirs_win32 import Win32ReadDir
1344
 
        self.assertDirReaderIs(Win32ReadDir)
 
890
        from bzrlib._walkdirs_win32 import _walkdirs_utf8_win32_find_file
 
891
        self.assertWalkdirsUtf8Is(_walkdirs_utf8_win32_find_file)
1345
892
 
1346
 
    def test_force_walkdirs_utf8_98(self):
1347
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
893
    def test_force_walkdirs_utf8_nt(self):
 
894
        self.requireFeature(WalkdirsWin32Feature)
1348
895
        self._save_platform_info()
1349
896
        win32utils.winver = 'Windows 98'
1350
 
        self.assertDirReaderIs(osutils.UnicodeDirReader)
 
897
        self.assertWalkdirsUtf8Is(osutils._walkdirs_unicode_to_utf8)
1351
898
 
1352
899
    def test_unicode_walkdirs(self):
1353
900
        """Walkdirs should always return unicode paths."""
1354
 
        self.requireFeature(features.UnicodeFilenameFeature)
1355
901
        name0 = u'0file-\xb6'
1356
902
        name1 = u'1dir-\u062c\u0648'
1357
903
        name2 = u'2file-\u0633'
1362
908
            name1 + '/' + name1 + '/',
1363
909
            name2,
1364
910
            ]
1365
 
        self.build_tree(tree)
 
911
        try:
 
912
            self.build_tree(tree)
 
913
        except UnicodeError:
 
914
            raise TestSkipped('Could not represent Unicode chars'
 
915
                              ' in current encoding.')
1366
916
        expected_dirblocks = [
1367
917
                ((u'', u'.'),
1368
918
                 [(name0, name0, 'file', './' + name0),
1394
944
 
1395
945
        The abspath portion might be in unicode or utf-8
1396
946
        """
1397
 
        self.requireFeature(features.UnicodeFilenameFeature)
1398
947
        name0 = u'0file-\xb6'
1399
948
        name1 = u'1dir-\u062c\u0648'
1400
949
        name2 = u'2file-\u0633'
1405
954
            name1 + '/' + name1 + '/',
1406
955
            name2,
1407
956
            ]
1408
 
        self.build_tree(tree)
 
957
        try:
 
958
            self.build_tree(tree)
 
959
        except UnicodeError:
 
960
            raise TestSkipped('Could not represent Unicode chars'
 
961
                              ' in current encoding.')
1409
962
        name0 = name0.encode('utf8')
1410
963
        name1 = name1.encode('utf8')
1411
964
        name2 = name2.encode('utf8')
1450
1003
            result.append((dirdetail, new_dirblock))
1451
1004
        self.assertEqual(expected_dirblocks, result)
1452
1005
 
1453
 
    def test__walkdirs_utf8_with_unicode_fs(self):
1454
 
        """UnicodeDirReader should be a safe fallback everywhere
 
1006
    def test_unicode__walkdirs_unicode_to_utf8(self):
 
1007
        """walkdirs_unicode_to_utf8 should be a safe fallback everywhere
1455
1008
 
1456
1009
        The abspath portion should be in unicode
1457
1010
        """
1458
 
        self.requireFeature(features.UnicodeFilenameFeature)
1459
 
        # Use the unicode reader. TODO: split into driver-and-driven unit
1460
 
        # tests.
1461
 
        self._save_platform_info()
1462
 
        osutils._selected_dir_reader = osutils.UnicodeDirReader()
1463
1011
        name0u = u'0file-\xb6'
1464
1012
        name1u = u'1dir-\u062c\u0648'
1465
1013
        name2u = u'2file-\u0633'
1470
1018
            name1u + '/' + name1u + '/',
1471
1019
            name2u,
1472
1020
            ]
1473
 
        self.build_tree(tree)
 
1021
        try:
 
1022
            self.build_tree(tree)
 
1023
        except UnicodeError:
 
1024
            raise TestSkipped('Could not represent Unicode chars'
 
1025
                              ' in current encoding.')
1474
1026
        name0 = name0u.encode('utf8')
1475
1027
        name1 = name1u.encode('utf8')
1476
1028
        name2 = name2u.encode('utf8')
1496
1048
                 ]
1497
1049
                ),
1498
1050
            ]
1499
 
        result = list(osutils._walkdirs_utf8('.'))
 
1051
        result = list(osutils._walkdirs_unicode_to_utf8('.'))
1500
1052
        self._filter_out_stat(result)
1501
1053
        self.assertEqual(expected_dirblocks, result)
1502
1054
 
1503
 
    def test__walkdirs_utf8_win32readdir(self):
1504
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1505
 
        self.requireFeature(features.UnicodeFilenameFeature)
1506
 
        from bzrlib._walkdirs_win32 import Win32ReadDir
1507
 
        self._save_platform_info()
1508
 
        osutils._selected_dir_reader = Win32ReadDir()
 
1055
    def test__walkdirs_utf_win32_find_file(self):
 
1056
        self.requireFeature(WalkdirsWin32Feature)
 
1057
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1058
        from bzrlib._walkdirs_win32 import _walkdirs_utf8_win32_find_file
1509
1059
        name0u = u'0file-\xb6'
1510
1060
        name1u = u'1dir-\u062c\u0648'
1511
1061
        name2u = u'2file-\u0633'
1542
1092
                 ]
1543
1093
                ),
1544
1094
            ]
1545
 
        result = list(osutils._walkdirs_utf8(u'.'))
 
1095
        result = list(_walkdirs_utf8_win32_find_file(u'.'))
1546
1096
        self._filter_out_stat(result)
1547
1097
        self.assertEqual(expected_dirblocks, result)
1548
1098
 
1558
1108
 
1559
1109
    def test__walkdirs_utf_win32_find_file_stat_file(self):
1560
1110
        """make sure our Stat values are valid"""
1561
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1562
 
        self.requireFeature(features.UnicodeFilenameFeature)
1563
 
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1111
        self.requireFeature(WalkdirsWin32Feature)
 
1112
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1113
        from bzrlib._walkdirs_win32 import _walkdirs_utf8_win32_find_file
1564
1114
        name0u = u'0file-\xb6'
1565
1115
        name0 = name0u.encode('utf8')
1566
1116
        self.build_tree([name0u])
1573
1123
        finally:
1574
1124
            f.close()
1575
1125
 
1576
 
        result = Win32ReadDir().read_dir('', u'.')
1577
 
        entry = result[0]
 
1126
        result = list(_walkdirs_utf8_win32_find_file(u'.'))
 
1127
        entry = result[0][1][0]
1578
1128
        self.assertEqual((name0, name0, 'file'), entry[:3])
1579
1129
        self.assertEqual(u'./' + name0u, entry[4])
1580
1130
        self.assertStatIsCorrect(entry[4], entry[3])
1582
1132
 
1583
1133
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
1584
1134
        """make sure our Stat values are valid"""
1585
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1586
 
        self.requireFeature(features.UnicodeFilenameFeature)
1587
 
        from bzrlib._walkdirs_win32 import Win32ReadDir
 
1135
        self.requireFeature(WalkdirsWin32Feature)
 
1136
        self.requireFeature(tests.UnicodeFilenameFeature)
 
1137
        from bzrlib._walkdirs_win32 import _walkdirs_utf8_win32_find_file
1588
1138
        name0u = u'0dir-\u062c\u0648'
1589
1139
        name0 = name0u.encode('utf8')
1590
1140
        self.build_tree([name0u + '/'])
1591
1141
 
1592
 
        result = Win32ReadDir().read_dir('', u'.')
1593
 
        entry = result[0]
 
1142
        result = list(_walkdirs_utf8_win32_find_file(u'.'))
 
1143
        entry = result[0][1][0]
1594
1144
        self.assertEqual((name0, name0, 'directory'), entry[:3])
1595
1145
        self.assertEqual(u'./' + name0u, entry[4])
1596
1146
        self.assertStatIsCorrect(entry[4], entry[3])
1673
1223
            sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
1674
1224
 
1675
1225
 
1676
 
class TestCopyTree(tests.TestCaseInTempDir):
1677
 
 
 
1226
class TestCopyTree(TestCaseInTempDir):
 
1227
    
1678
1228
    def test_copy_basic_tree(self):
1679
1229
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1680
1230
        osutils.copy_tree('source', 'target')
1689
1239
        self.assertEqual(['c'], os.listdir('target/b'))
1690
1240
 
1691
1241
    def test_copy_tree_symlinks(self):
1692
 
        self.requireFeature(features.SymlinkFeature)
 
1242
        self.requireFeature(SymlinkFeature)
1693
1243
        self.build_tree(['source/'])
1694
1244
        os.symlink('a/generic/path', 'source/lnk')
1695
1245
        osutils.copy_tree('source', 'target')
1720
1270
                          ('d', 'source/b', 'target/b'),
1721
1271
                          ('f', 'source/b/c', 'target/b/c'),
1722
1272
                         ], processed_files)
1723
 
        self.assertPathDoesNotExist('target')
 
1273
        self.failIfExists('target')
1724
1274
        if osutils.has_symlinks():
1725
1275
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1726
1276
 
1727
1277
 
1728
 
class TestSetUnsetEnv(tests.TestCase):
 
1278
#class TestTerminalEncoding has been moved to test_osutils_encodings.py
 
1279
# [bialix] 2006/12/26
 
1280
 
 
1281
 
 
1282
class TestSetUnsetEnv(TestCase):
1729
1283
    """Test updating the environment"""
1730
1284
 
1731
1285
    def setUp(self):
1737
1291
        def cleanup():
1738
1292
            if 'BZR_TEST_ENV_VAR' in os.environ:
1739
1293
                del os.environ['BZR_TEST_ENV_VAR']
 
1294
 
1740
1295
        self.addCleanup(cleanup)
1741
1296
 
1742
1297
    def test_set(self):
1754
1309
 
1755
1310
    def test_unicode(self):
1756
1311
        """Environment can only contain plain strings
1757
 
 
 
1312
        
1758
1313
        So Unicode strings must be encoded.
1759
1314
        """
1760
 
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
1315
        uni_val, env_val = probe_unicode_in_user_encoding()
1761
1316
        if uni_val is None:
1762
 
            raise tests.TestSkipped(
1763
 
                'Cannot find a unicode character that works in encoding %s'
1764
 
                % (osutils.get_user_encoding(),))
 
1317
            raise TestSkipped('Cannot find a unicode character that works in'
 
1318
                              ' encoding %s' % (bzrlib.user_encoding,))
1765
1319
 
1766
1320
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
1767
1321
        self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
1772
1326
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1773
1327
        self.assertEqual('foo', old)
1774
1328
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1775
 
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1776
 
 
1777
 
 
1778
 
class TestSizeShaFile(tests.TestCaseInTempDir):
1779
 
 
1780
 
    def test_sha_empty(self):
1781
 
        self.build_tree_contents([('foo', '')])
1782
 
        expected_sha = osutils.sha_string('')
1783
 
        f = open('foo')
1784
 
        self.addCleanup(f.close)
1785
 
        size, sha = osutils.size_sha_file(f)
1786
 
        self.assertEqual(0, size)
1787
 
        self.assertEqual(expected_sha, sha)
1788
 
 
1789
 
    def test_sha_mixed_endings(self):
1790
 
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
1791
 
        self.build_tree_contents([('foo', text)])
1792
 
        expected_sha = osutils.sha_string(text)
1793
 
        f = open('foo', 'rb')
1794
 
        self.addCleanup(f.close)
1795
 
        size, sha = osutils.size_sha_file(f)
1796
 
        self.assertEqual(38, size)
1797
 
        self.assertEqual(expected_sha, sha)
1798
 
 
1799
 
 
1800
 
class TestShaFileByName(tests.TestCaseInTempDir):
1801
 
 
1802
 
    def test_sha_empty(self):
1803
 
        self.build_tree_contents([('foo', '')])
1804
 
        expected_sha = osutils.sha_string('')
1805
 
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1806
 
 
1807
 
    def test_sha_mixed_endings(self):
1808
 
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
1809
 
        self.build_tree_contents([('foo', text)])
1810
 
        expected_sha = osutils.sha_string(text)
1811
 
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1812
 
 
1813
 
 
1814
 
class TestResourceLoading(tests.TestCaseInTempDir):
 
1329
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
 
1330
 
 
1331
 
 
1332
class TestLocalTimeOffset(TestCase):
 
1333
 
 
1334
    def test_local_time_offset(self):
 
1335
        """Test that local_time_offset() returns a sane value."""
 
1336
        offset = osutils.local_time_offset()
 
1337
        self.assertTrue(isinstance(offset, int))
 
1338
        # Test that the offset is no more than a eighteen hours in
 
1339
        # either direction.
 
1340
        # Time zone handling is system specific, so it is difficult to
 
1341
        # do more specific tests, but a value outside of this range is
 
1342
        # probably wrong.
 
1343
        eighteen_hours = 18 * 3600
 
1344
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
1345
 
 
1346
    def test_local_time_offset_with_timestamp(self):
 
1347
        """Test that local_time_offset() works with a timestamp."""
 
1348
        offset = osutils.local_time_offset(1000000000.1234567)
 
1349
        self.assertTrue(isinstance(offset, int))
 
1350
        eighteen_hours = 18 * 3600
 
1351
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
 
1352
 
 
1353
 
 
1354
class TestShaFileByName(TestCaseInTempDir):
 
1355
 
 
1356
    def test_sha_empty(self):
 
1357
        self.build_tree_contents([('foo', '')])
 
1358
        expected_sha = osutils.sha_string('')
 
1359
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1360
 
 
1361
    def test_sha_mixed_endings(self):
 
1362
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
 
1363
        self.build_tree_contents([('foo', text)])
 
1364
        expected_sha = osutils.sha_string(text)
 
1365
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
 
1366
 
 
1367
 
 
1368
_debug_text = \
 
1369
r'''# Copyright (C) 2005, 2006 Canonical Ltd
 
1370
#
 
1371
# This program is free software; you can redistribute it and/or modify
 
1372
# it under the terms of the GNU General Public License as published by
 
1373
# the Free Software Foundation; either version 2 of the License, or
 
1374
# (at your option) any later version.
 
1375
#
 
1376
# This program is distributed in the hope that it will be useful,
 
1377
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
1378
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
1379
# GNU General Public License for more details.
 
1380
#
 
1381
# You should have received a copy of the GNU General Public License
 
1382
# along with this program; if not, write to the Free Software
 
1383
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
1384
 
 
1385
 
 
1386
# NOTE: If update these, please also update the help for global-options in
 
1387
#       bzrlib/help_topics/__init__.py
 
1388
 
 
1389
debug_flags = set()
 
1390
"""Set of flags that enable different debug behaviour.
 
1391
 
 
1392
These are set with eg ``-Dlock`` on the bzr command line.
 
1393
 
 
1394
Options include:
 
1395
 
 
1396
 * auth - show authentication sections used
 
1397
 * error - show stack traces for all top level exceptions
 
1398
 * evil - capture call sites that do expensive or badly-scaling operations.
 
1399
 * fetch - trace history copying between repositories
 
1400
 * graph - trace graph traversal information
 
1401
 * hashcache - log every time a working file is read to determine its hash
 
1402
 * hooks - trace hook execution
 
1403
 * hpss - trace smart protocol requests and responses
 
1404
 * http - trace http connections, requests and responses
 
1405
 * index - trace major index operations
 
1406
 * knit - trace knit operations
 
1407
 * lock - trace when lockdir locks are taken or released
 
1408
 * merge - emit information for debugging merges
 
1409
 * pack - emit information about pack operations
 
1410
 
 
1411
"""
 
1412
'''
 
1413
 
 
1414
 
 
1415
class TestResourceLoading(TestCaseInTempDir):
1815
1416
 
1816
1417
    def test_resource_string(self):
1817
1418
        # test resource in bzrlib
1818
1419
        text = osutils.resource_string('bzrlib', 'debug.py')
1819
 
        self.assertContainsRe(text, "debug_flags = set()")
 
1420
        self.assertEquals(_debug_text, text)
1820
1421
        # test resource under bzrlib
1821
1422
        text = osutils.resource_string('bzrlib.ui', 'text.py')
1822
1423
        self.assertContainsRe(text, "class TextUIFactory")
1825
1426
            'yyy.xx')
1826
1427
        # test unknown resource
1827
1428
        self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
1828
 
 
1829
 
 
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)
1835
 
 
1836
 
    def test_re_compile_checked(self):
1837
 
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1838
 
        self.assertTrue(r.match('aaaa'))
1839
 
        self.assertTrue(r.match('aAaA'))
1840
 
 
1841
 
    def test_re_compile_checked_error(self):
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()
1847
 
        err = self.assertRaises(
1848
 
            errors.BzrCommandError,
1849
 
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1850
 
        self.assertEqual(
1851
 
            'Invalid regular expression in test case: '
1852
 
            '"*" nothing to repeat',
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.assertEqual(self.target,  os.readlink(self.link))
2007
 
 
2008
 
    def test_os_readlink_link_decoding(self):
2009
 
        self.assertEqual(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.assertEqual('42', os.environ['BZR_CONCURRENCY'])
2036
 
        self.assertEqual(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.assertEqual(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.assertEqual(self.path, 'test_file')
2183
 
        self.assertEqual(self.uid, s.st_uid)
2184
 
        self.assertEqual(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.assertEqual(self.path, 'test_file')
2194
 
        self.assertEqual(self.uid, s.st_uid)
2195
 
        self.assertEqual(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")))