1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for the osutils wrapper."""
19
from cStringIO import StringIO
38
from bzrlib.tests import (
43
from bzrlib.tests.scenarios import load_tests_apply_scenarios
46
class _UTF8DirReaderFeature(features.Feature):
50
from bzrlib import _readdir_pyx
51
self.reader = _readdir_pyx.UTF8DirReader
56
def feature_name(self):
57
return 'bzrlib._readdir_pyx'
59
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
61
term_ios_feature = features.ModuleAvailableFeature('termios')
64
def _already_unicode(s):
68
def _utf8_to_unicode(s):
69
return s.decode('UTF-8')
72
def dir_reader_scenarios():
73
# For each dir reader we define:
75
# - native_to_unicode: a function converting the native_abspath as returned
76
# by DirReader.read_dir to its unicode representation
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
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)))
90
if test__walkdirs_win32.win32_readdir_feature.available():
92
from bzrlib import _walkdirs_win32
95
dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
96
_native_to_unicode=_already_unicode)))
102
load_tests = load_tests_apply_scenarios
105
class TestContainsWhitespace(tests.TestCase):
107
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'))
115
# \xa0 is "Non-breaking-space" which on some python locales thinks it
116
# 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'))
122
class TestRename(tests.TestCaseInTempDir):
124
def create_file(self, filename, content):
125
f = open(filename, 'wb')
131
def _fancy_rename(self, a, b):
132
osutils.fancy_rename(a, b, rename_func=os.rename,
133
unlink_func=os.unlink)
135
def test_fancy_rename(self):
136
# 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')
141
self.check_file_contents('b', 'something in a\n')
143
self.create_file('a', 'new something in a\n')
144
self._fancy_rename('b', 'a')
146
self.check_file_contents('a', 'something in a\n')
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')
156
def test_fancy_rename_fails_if_source_and_target_missing(self):
157
self.assertRaises((IOError, OSError), self._fancy_rename,
158
'missingsource', 'missingtarget')
160
def test_rename(self):
161
# Rename should be semi-atomic on all platforms
162
self.create_file('a', 'something in a\n')
163
osutils.rename('a', 'b')
164
self.assertPathDoesNotExist('a')
165
self.assertPathExists('b')
166
self.check_file_contents('b', 'something in a\n')
168
self.create_file('a', 'new something in a\n')
169
osutils.rename('b', 'a')
171
self.check_file_contents('a', 'something in a\n')
173
# TODO: test fancy_rename using a MemoryTransport
175
def test_rename_change_case(self):
176
# on Windows we should be able to change filename case by rename
177
self.build_tree(['a', 'b/'])
178
osutils.rename('a', 'A')
179
osutils.rename('b', 'B')
180
# we can't use failUnlessExists on case-insensitive filesystem
181
# so try to check shape of the tree
182
shape = sorted(os.listdir('.'))
183
self.assertEquals(['A', 'B'], shape)
185
def test_rename_exception(self):
187
osutils.rename('nonexistent_path', 'different_nonexistent_path')
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)
195
class TestRandChars(tests.TestCase):
197
def test_01_rand_chars_empty(self):
198
result = osutils.rand_chars(0)
199
self.assertEqual(result, '')
201
def test_02_rand_chars_100(self):
202
result = osutils.rand_chars(100)
203
self.assertEqual(len(result), 100)
204
self.assertEqual(type(result), str)
205
self.assertContainsRe(result, r'^[a-z0-9]{100}$')
208
class TestIsInside(tests.TestCase):
210
def test_is_inside(self):
211
is_inside = osutils.is_inside
212
self.assertTrue(is_inside('src', 'src/foo.c'))
213
self.assertFalse(is_inside('src', 'srccontrol'))
214
self.assertTrue(is_inside('src', 'src/a/a/a/foo.c'))
215
self.assertTrue(is_inside('foo.c', 'foo.c'))
216
self.assertFalse(is_inside('foo.c', ''))
217
self.assertTrue(is_inside('', 'foo.c'))
219
def test_is_inside_any(self):
220
SRC_FOO_C = osutils.pathjoin('src', 'foo.c')
221
for dirs, fn in [(['src', 'doc'], SRC_FOO_C),
222
(['src'], SRC_FOO_C),
225
self.assert_(osutils.is_inside_any(dirs, fn))
226
for dirs, fn in [(['src'], 'srccontrol'),
227
(['src'], 'srccontrol/foo')]:
228
self.assertFalse(osutils.is_inside_any(dirs, fn))
230
def test_is_inside_or_parent_of_any(self):
231
for dirs, fn in [(['src', 'doc'], 'src/foo.c'),
232
(['src'], 'src/foo.c'),
233
(['src/bar.c'], 'src'),
234
(['src/bar.c', 'bla/foo.c'], 'src'),
237
self.assert_(osutils.is_inside_or_parent_of_any(dirs, fn))
239
for dirs, fn in [(['src'], 'srccontrol'),
240
(['srccontrol/foo.c'], 'src'),
241
(['src'], 'srccontrol/foo')]:
242
self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
245
class TestLstat(tests.TestCaseInTempDir):
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')
260
self.assertEqualStat(osutils.fstat(f.fileno()),
261
osutils.lstat('test-file.txt'))
264
class TestRmTree(tests.TestCaseInTempDir):
266
def test_rmtree(self):
267
# Check to remove tree with read-only files/dirs
269
f = file('dir/file', 'w')
272
# would like to also try making the directory readonly, but at the
273
# moment python shutil.rmtree doesn't handle that properly - it would
274
# need to chmod the directory before removing things inside it - deferred
275
# for now -- mbp 20060505
276
# osutils.make_readonly('dir')
277
osutils.make_readonly('dir/file')
279
osutils.rmtree('dir')
281
self.assertPathDoesNotExist('dir/file')
282
self.assertPathDoesNotExist('dir')
285
class TestDeleteAny(tests.TestCaseInTempDir):
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')
293
osutils.delete_any('f')
294
osutils.delete_any('d')
297
class TestKind(tests.TestCaseInTempDir):
299
def test_file_kind(self):
300
self.build_tree(['file', 'dir/'])
301
self.assertEquals('file', osutils.file_kind('file'))
302
self.assertEquals('directory', osutils.file_kind('dir/'))
303
if osutils.has_symlinks():
304
os.symlink('symlink', 'symlink')
305
self.assertEquals('symlink', osutils.file_kind('symlink'))
307
# TODO: jam 20060529 Test a block device
309
os.lstat('/dev/null')
311
if e.errno not in (errno.ENOENT,):
314
self.assertEquals('chardev', osutils.file_kind('/dev/null'))
316
mkfifo = getattr(os, 'mkfifo', None)
320
self.assertEquals('fifo', osutils.file_kind('fifo'))
324
AF_UNIX = getattr(socket, 'AF_UNIX', None)
326
s = socket.socket(AF_UNIX)
329
self.assertEquals('socket', osutils.file_kind('socket'))
333
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"))
344
class TestUmask(tests.TestCaseInTempDir):
346
def test_get_umask(self):
347
if sys.platform == 'win32':
348
# umask always returns '0', no way to set it
349
self.assertEqual(0, osutils.get_umask())
352
orig_umask = osutils.get_umask()
353
self.addCleanup(os.umask, orig_umask)
355
self.assertEqual(0222, osutils.get_umask())
357
self.assertEqual(0022, osutils.get_umask())
359
self.assertEqual(0002, osutils.get_umask())
361
self.assertEqual(0027, osutils.get_umask())
364
class TestDateTime(tests.TestCase):
366
def assertFormatedDelta(self, expected, seconds):
367
"""Assert osutils.format_delta formats as expected"""
368
actual = osutils.format_delta(seconds)
369
self.assertEqual(expected, actual)
371
def test_format_delta(self):
372
self.assertFormatedDelta('0 seconds ago', 0)
373
self.assertFormatedDelta('1 second ago', 1)
374
self.assertFormatedDelta('10 seconds ago', 10)
375
self.assertFormatedDelta('59 seconds ago', 59)
376
self.assertFormatedDelta('89 seconds ago', 89)
377
self.assertFormatedDelta('1 minute, 30 seconds ago', 90)
378
self.assertFormatedDelta('3 minutes, 0 seconds ago', 180)
379
self.assertFormatedDelta('3 minutes, 1 second ago', 181)
380
self.assertFormatedDelta('10 minutes, 15 seconds ago', 615)
381
self.assertFormatedDelta('30 minutes, 59 seconds ago', 1859)
382
self.assertFormatedDelta('31 minutes, 0 seconds ago', 1860)
383
self.assertFormatedDelta('60 minutes, 0 seconds ago', 3600)
384
self.assertFormatedDelta('89 minutes, 59 seconds ago', 5399)
385
self.assertFormatedDelta('1 hour, 30 minutes ago', 5400)
386
self.assertFormatedDelta('2 hours, 30 minutes ago', 9017)
387
self.assertFormatedDelta('10 hours, 0 minutes ago', 36000)
388
self.assertFormatedDelta('24 hours, 0 minutes ago', 86400)
389
self.assertFormatedDelta('35 hours, 59 minutes ago', 129599)
390
self.assertFormatedDelta('36 hours, 0 minutes ago', 129600)
391
self.assertFormatedDelta('36 hours, 0 minutes ago', 129601)
392
self.assertFormatedDelta('36 hours, 1 minute ago', 129660)
393
self.assertFormatedDelta('36 hours, 1 minute ago', 129661)
394
self.assertFormatedDelta('84 hours, 10 minutes ago', 303002)
396
# We handle when time steps the wrong direction because computers
397
# don't have synchronized clocks.
398
self.assertFormatedDelta('84 hours, 10 minutes in the future', -303002)
399
self.assertFormatedDelta('1 second in the future', -1)
400
self.assertFormatedDelta('2 seconds in the future', -2)
402
def test_format_date(self):
403
self.assertRaises(errors.UnsupportedTimezoneFormat,
404
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.
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))
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
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
429
eighteen_hours = 18 * 3600
430
self.assertTrue(-eighteen_hours < offset < eighteen_hours)
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)
440
class TestFdatasync(tests.TestCaseInTempDir):
442
def do_fdatasync(self):
443
f = tempfile.NamedTemporaryFile()
444
osutils.fdatasync(f.fileno())
448
def raise_eopnotsupp(*args, **kwargs):
449
raise IOError(errno.EOPNOTSUPP, os.strerror(errno.EOPNOTSUPP))
452
def raise_enotsup(*args, **kwargs):
453
raise IOError(errno.ENOTSUP, os.strerror(errno.ENOTSUP))
455
def test_fdatasync_handles_system_function(self):
456
self.overrideAttr(os, "fdatasync")
459
def test_fdatasync_handles_no_fdatasync_no_fsync(self):
460
self.overrideAttr(os, "fdatasync")
461
self.overrideAttr(os, "fsync")
464
def test_fdatasync_handles_no_EOPNOTSUPP(self):
465
self.overrideAttr(errno, "EOPNOTSUPP")
468
def test_fdatasync_catches_ENOTSUP(self):
469
enotsup = getattr(errno, "ENOTSUP", None)
471
raise tests.TestNotApplicable("No ENOTSUP on this platform")
472
self.overrideAttr(os, "fdatasync", self.raise_enotsup)
475
def test_fdatasync_catches_EOPNOTSUPP(self):
476
enotsup = getattr(errno, "EOPNOTSUPP", None)
478
raise tests.TestNotApplicable("No EOPNOTSUPP on this platform")
479
self.overrideAttr(os, "fdatasync", self.raise_eopnotsupp)
483
class TestLinks(tests.TestCaseInTempDir):
485
def test_dereference_path(self):
486
self.requireFeature(features.SymlinkFeature)
487
cwd = osutils.realpath('.')
489
bar_path = osutils.pathjoin(cwd, 'bar')
490
# Using './' to avoid bug #1213894 (first path component not
491
# dereferenced) in Python 2.4.1 and earlier
492
self.assertEqual(bar_path, osutils.realpath('./bar'))
493
os.symlink('bar', 'foo')
494
self.assertEqual(bar_path, osutils.realpath('./foo'))
496
# Does not dereference terminal symlinks
497
foo_path = osutils.pathjoin(cwd, 'foo')
498
self.assertEqual(foo_path, osutils.dereference_path('./foo'))
500
# Dereferences parent symlinks
502
baz_path = osutils.pathjoin(bar_path, 'baz')
503
self.assertEqual(baz_path, osutils.dereference_path('./foo/baz'))
505
# Dereferences parent symlinks that are the first path element
506
self.assertEqual(baz_path, osutils.dereference_path('foo/baz'))
508
# Dereferences parent symlinks in absolute paths
509
foo_baz_path = osutils.pathjoin(foo_path, 'baz')
510
self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
512
def test_changing_access(self):
513
f = file('file', 'w')
517
# Make a file readonly
518
osutils.make_readonly('file')
519
mode = os.lstat('file').st_mode
520
self.assertEqual(mode, mode & 0777555)
522
# Make a file writable
523
osutils.make_writable('file')
524
mode = os.lstat('file').st_mode
525
self.assertEqual(mode, mode | 0200)
527
if osutils.has_symlinks():
528
# should not error when handed a symlink
529
os.symlink('nonexistent', 'dangling')
530
osutils.make_readonly('dangling')
531
osutils.make_writable('dangling')
533
def test_host_os_dereferences_symlinks(self):
534
osutils.host_os_dereferences_symlinks()
537
class TestCanonicalRelPath(tests.TestCaseInTempDir):
539
_test_needs_features = [features.CaseInsCasePresFilenameFeature]
541
def test_canonical_relpath_simple(self):
542
f = file('MixedCaseName', 'w')
544
actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
545
self.assertEqual('work/MixedCaseName', actual)
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)
554
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
556
def assertRelpath(self, expected, base, path):
557
actual = osutils._cicp_canonical_relpath(base, path)
558
self.assertEqual(expected, actual)
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')
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')
575
def test_at_root_slash(self):
576
# We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
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')
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'
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')
597
class TestPumpFile(tests.TestCase):
598
"""Test pumpfile method."""
601
super(TestPumpFile, self).setUp()
602
# create a test datablock
603
self.block_size = 512
604
pattern = '0123456789ABCDEF'
605
self.test_data = pattern * (3 * self.block_size / len(pattern))
606
self.test_data_len = len(self.test_data)
608
def test_bracket_block_size(self):
609
"""Read data in blocks with the requested read size bracketing the
611
# make sure test data is larger than max read size
612
self.assertTrue(self.test_data_len > self.block_size)
614
from_file = file_utils.FakeReadFile(self.test_data)
617
# read (max / 2) bytes and verify read size wasn't affected
618
num_bytes_to_read = self.block_size / 2
619
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
620
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
621
self.assertEqual(from_file.get_read_count(), 1)
623
# read (max) bytes and verify read size wasn't affected
624
num_bytes_to_read = self.block_size
625
from_file.reset_read_count()
626
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
627
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
628
self.assertEqual(from_file.get_read_count(), 1)
630
# read (max + 1) bytes and verify read size was limited
631
num_bytes_to_read = self.block_size + 1
632
from_file.reset_read_count()
633
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
634
self.assertEqual(from_file.get_max_read_size(), self.block_size)
635
self.assertEqual(from_file.get_read_count(), 2)
637
# finish reading the rest of the data
638
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)
641
# report error if the data wasn't equal (we only report the size due
642
# to the length of the data)
643
response_data = to_file.getvalue()
644
if response_data != self.test_data:
645
message = "Data not equal. Expected %d bytes, received %d."
646
self.fail(message % (len(response_data), self.test_data_len))
648
def test_specified_size(self):
649
"""Request a transfer larger than the maximum block size and verify
650
that the maximum read doesn't exceed the block_size."""
651
# make sure test data is larger than max read size
652
self.assertTrue(self.test_data_len > self.block_size)
654
# retrieve data in blocks
655
from_file = file_utils.FakeReadFile(self.test_data)
657
osutils.pumpfile(from_file, to_file, self.test_data_len,
660
# verify read size was equal to the maximum read size
661
self.assertTrue(from_file.get_max_read_size() > 0)
662
self.assertEqual(from_file.get_max_read_size(), self.block_size)
663
self.assertEqual(from_file.get_read_count(), 3)
665
# report error if the data wasn't equal (we only report the size due
666
# to the length of the data)
667
response_data = to_file.getvalue()
668
if response_data != self.test_data:
669
message = "Data not equal. Expected %d bytes, received %d."
670
self.fail(message % (len(response_data), self.test_data_len))
672
def test_to_eof(self):
673
"""Read to end-of-file and verify that the reads are not larger than
674
the maximum read size."""
675
# make sure test data is larger than max read size
676
self.assertTrue(self.test_data_len > self.block_size)
678
# retrieve data to EOF
679
from_file = file_utils.FakeReadFile(self.test_data)
681
osutils.pumpfile(from_file, to_file, -1, self.block_size)
683
# verify read size was equal to the maximum read size
684
self.assertEqual(from_file.get_max_read_size(), self.block_size)
685
self.assertEqual(from_file.get_read_count(), 4)
687
# report error if the data wasn't equal (we only report the size due
688
# to the length of the data)
689
response_data = to_file.getvalue()
690
if response_data != self.test_data:
691
message = "Data not equal. Expected %d bytes, received %d."
692
self.fail(message % (len(response_data), self.test_data_len))
694
def test_defaults(self):
695
"""Verifies that the default arguments will read to EOF -- this
696
test verifies that any existing usages of pumpfile will not be broken
697
with this new version."""
698
# retrieve data using default (old) pumpfile method
699
from_file = file_utils.FakeReadFile(self.test_data)
701
osutils.pumpfile(from_file, to_file)
703
# report error if the data wasn't equal (we only report the size due
704
# to the length of the data)
705
response_data = to_file.getvalue()
706
if response_data != self.test_data:
707
message = "Data not equal. Expected %d bytes, received %d."
708
self.fail(message % (len(response_data), self.test_data_len))
710
def test_report_activity(self):
712
def log_activity(length, direction):
713
activity.append((length, direction))
714
from_file = StringIO(self.test_data)
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)
721
from_file = StringIO(self.test_data)
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)
729
# And with a limited amount of data
730
from_file = StringIO(self.test_data)
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)
739
class TestPumpStringFile(tests.TestCase):
741
def test_empty(self):
743
osutils.pump_string_file("", output)
744
self.assertEqual("", output.getvalue())
746
def test_more_than_segment_size(self):
748
osutils.pump_string_file("123456789", output, 2)
749
self.assertEqual("123456789", output.getvalue())
751
def test_segment_size(self):
753
osutils.pump_string_file("12", output, 2)
754
self.assertEqual("12", output.getvalue())
756
def test_segment_size_multiple(self):
758
osutils.pump_string_file("1234", output, 2)
759
self.assertEqual("1234", output.getvalue())
762
class TestRelpath(tests.TestCase):
764
def test_simple_relpath(self):
765
cwd = osutils.getcwd()
766
subdir = cwd + '/subdir'
767
self.assertEqual('subdir', osutils.relpath(cwd, subdir))
769
def test_deep_relpath(self):
770
cwd = osutils.getcwd()
771
subdir = cwd + '/sub/subsubdir'
772
self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
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')
781
class TestSafeUnicode(tests.TestCase):
783
def test_from_ascii_string(self):
784
self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
786
def test_from_unicode_string_ascii_contents(self):
787
self.assertEqual(u'bargam', osutils.safe_unicode(u'bargam'))
789
def test_from_unicode_string_unicode_contents(self):
790
self.assertEqual(u'bargam\xae', osutils.safe_unicode(u'bargam\xae'))
792
def test_from_utf8_string(self):
793
self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
795
def test_bad_utf8_string(self):
796
self.assertRaises(errors.BzrBadParameterNotUnicode,
797
osutils.safe_unicode,
801
class TestSafeUtf8(tests.TestCase):
803
def test_from_ascii_string(self):
805
self.assertEqual('foobar', osutils.safe_utf8(f))
807
def test_from_unicode_string_ascii_contents(self):
808
self.assertEqual('bargam', osutils.safe_utf8(u'bargam'))
810
def test_from_unicode_string_unicode_contents(self):
811
self.assertEqual('bargam\xc2\xae', osutils.safe_utf8(u'bargam\xae'))
813
def test_from_utf8_string(self):
814
self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
816
def test_bad_utf8_string(self):
817
self.assertRaises(errors.BzrBadParameterNotUnicode,
818
osutils.safe_utf8, '\xbb\xbb')
821
class TestSafeRevisionId(tests.TestCase):
823
def test_from_ascii_string(self):
824
# this shouldn't give a warning because it's getting an ascii string
825
self.assertEqual('foobar', osutils.safe_revision_id('foobar'))
827
def test_from_unicode_string_ascii_contents(self):
828
self.assertEqual('bargam',
829
osutils.safe_revision_id(u'bargam', warn=False))
831
def test_from_unicode_deprecated(self):
832
self.assertEqual('bargam',
833
self.callDeprecated([osutils._revision_id_warning],
834
osutils.safe_revision_id, u'bargam'))
836
def test_from_unicode_string_unicode_contents(self):
837
self.assertEqual('bargam\xc2\xae',
838
osutils.safe_revision_id(u'bargam\xae', warn=False))
840
def test_from_utf8_string(self):
841
self.assertEqual('foo\xc2\xae',
842
osutils.safe_revision_id('foo\xc2\xae'))
845
"""Currently, None is a valid revision_id"""
846
self.assertEqual(None, osutils.safe_revision_id(None))
849
class TestSafeFileId(tests.TestCase):
851
def test_from_ascii_string(self):
852
self.assertEqual('foobar', osutils.safe_file_id('foobar'))
854
def test_from_unicode_string_ascii_contents(self):
855
self.assertEqual('bargam', osutils.safe_file_id(u'bargam', warn=False))
857
def test_from_unicode_deprecated(self):
858
self.assertEqual('bargam',
859
self.callDeprecated([osutils._file_id_warning],
860
osutils.safe_file_id, u'bargam'))
862
def test_from_unicode_string_unicode_contents(self):
863
self.assertEqual('bargam\xc2\xae',
864
osutils.safe_file_id(u'bargam\xae', warn=False))
866
def test_from_utf8_string(self):
867
self.assertEqual('foo\xc2\xae',
868
osutils.safe_file_id('foo\xc2\xae'))
871
"""Currently, None is a valid revision_id"""
872
self.assertEqual(None, osutils.safe_file_id(None))
875
class TestSendAll(tests.TestCase):
877
def test_send_with_disconnected_socket(self):
878
class DisconnectedSocket(object):
879
def __init__(self, err):
881
def send(self, content):
885
# All of these should be treated as ConnectionReset
887
for err_cls in (IOError, socket.error):
888
for errnum in osutils._end_of_stream_errors:
889
errs.append(err_cls(errnum))
891
sock = DisconnectedSocket(err)
892
self.assertRaises(errors.ConnectionReset,
893
osutils.send_all, sock, 'some more content')
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):
902
def send(self, bytes):
904
if self.call_count > 100:
905
# Prevent the test suite from hanging
906
raise RuntimeError('too many calls')
908
sock = NoSendingSocket()
909
self.assertRaises(errors.ConnectionReset,
910
osutils.send_all, sock, 'content')
911
self.assertEqual(1, sock.call_count)
914
class TestPosixFuncs(tests.TestCase):
915
"""Test that the posix version of normpath returns an appropriate path
916
when used with 2 leading slashes."""
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'))
924
class TestWin32Funcs(tests.TestCase):
925
"""Test that _win32 versions of os utilities return appropriate paths."""
927
def test_abspath(self):
928
self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
929
self.assertEqual('C:/foo', osutils._win32_abspath('C:/foo'))
930
self.assertEqual('//HOST/path', osutils._win32_abspath(r'\\HOST\path'))
931
self.assertEqual('//HOST/path', osutils._win32_abspath('//HOST/path'))
933
def test_realpath(self):
934
self.assertEqual('C:/foo', osutils._win32_realpath('C:\\foo'))
935
self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
937
def test_pathjoin(self):
938
self.assertEqual('path/to/foo',
939
osutils._win32_pathjoin('path', 'to', 'foo'))
940
self.assertEqual('C:/foo',
941
osutils._win32_pathjoin('path\\to', 'C:\\foo'))
942
self.assertEqual('C:/foo',
943
osutils._win32_pathjoin('path/to', 'C:/foo'))
944
self.assertEqual('path/to/foo',
945
osutils._win32_pathjoin('path/to/', 'foo'))
946
self.assertEqual('/foo',
947
osutils._win32_pathjoin('C:/path/to/', '/foo'))
948
self.assertEqual('/foo',
949
osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
951
def test_normpath(self):
952
self.assertEqual('path/to/foo',
953
osutils._win32_normpath(r'path\\from\..\to\.\foo'))
954
self.assertEqual('path/to/foo',
955
osutils._win32_normpath('path//from/../to/./foo'))
957
def test_getcwd(self):
958
cwd = osutils._win32_getcwd()
959
os_cwd = os.getcwdu()
960
self.assertEqual(os_cwd[1:].replace('\\', '/'), cwd[1:])
961
# win32 is inconsistent whether it returns lower or upper case
962
# and even if it was consistent the user might type the other
963
# so we force it to uppercase
964
# running python.exe under cmd.exe return capital C:\\
965
# running win32 python inside a cygwin shell returns lowercase
966
self.assertEqual(os_cwd[0].upper(), cwd[0])
968
def test_fixdrive(self):
969
self.assertEqual('H:/foo', osutils._win32_fixdrive('h:/foo'))
970
self.assertEqual('H:/foo', osutils._win32_fixdrive('H:/foo'))
971
self.assertEqual('C:\\foo', osutils._win32_fixdrive('c:\\foo'))
973
def test_win98_abspath(self):
975
self.assertEqual('C:/foo', osutils._win98_abspath('C:\\foo'))
976
self.assertEqual('C:/foo', osutils._win98_abspath('C:/foo'))
978
self.assertEqual('//HOST/path', osutils._win98_abspath(r'\\HOST\path'))
979
self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
981
cwd = osutils.getcwd().rstrip('/')
982
drive = osutils.ntpath.splitdrive(cwd)[0]
983
self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
984
self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
987
self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
990
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
991
"""Test win32 functions that create files."""
993
def test_getcwd(self):
994
self.requireFeature(features.UnicodeFilenameFeature)
997
# TODO: jam 20060427 This will probably fail on Mac OSX because
998
# it will change the normalization of B\xe5gfors
999
# Consider using a different unicode character, or make
1000
# osutils.getcwd() renormalize the path.
1001
self.assertEndsWith(osutils._win32_getcwd(), u'mu-\xb5')
1003
def test_minimum_path_selection(self):
1004
self.assertEqual(set(),
1005
osutils.minimum_path_selection([]))
1006
self.assertEqual(set(['a']),
1007
osutils.minimum_path_selection(['a']))
1008
self.assertEqual(set(['a', 'b']),
1009
osutils.minimum_path_selection(['a', 'b']))
1010
self.assertEqual(set(['a/', 'b']),
1011
osutils.minimum_path_selection(['a/', 'b']))
1012
self.assertEqual(set(['a/', 'b']),
1013
osutils.minimum_path_selection(['a/c', 'a/', 'b']))
1014
self.assertEqual(set(['a-b', 'a', 'a0b']),
1015
osutils.minimum_path_selection(['a-b', 'a/b', 'a0b', 'a']))
1017
def test_mkdtemp(self):
1018
tmpdir = osutils._win32_mkdtemp(dir='.')
1019
self.assertFalse('\\' in tmpdir)
1021
def test_rename(self):
1029
osutils._win32_rename('b', 'a')
1030
self.assertPathExists('a')
1031
self.assertPathDoesNotExist('b')
1032
self.assertFileEqual('baz\n', 'a')
1034
def test_rename_missing_file(self):
1040
osutils._win32_rename('b', 'a')
1041
except (IOError, OSError), e:
1042
self.assertEqual(errno.ENOENT, e.errno)
1043
self.assertFileEqual('foo\n', 'a')
1045
def test_rename_missing_dir(self):
1048
osutils._win32_rename('b', 'a')
1049
except (IOError, OSError), e:
1050
self.assertEqual(errno.ENOENT, e.errno)
1052
def test_rename_current_dir(self):
1055
# You can't rename the working directory
1056
# doing rename non-existant . usually
1057
# just raises ENOENT, since non-existant
1060
osutils._win32_rename('b', '.')
1061
except (IOError, OSError), e:
1062
self.assertEqual(errno.ENOENT, e.errno)
1064
def test_splitpath(self):
1065
def check(expected, path):
1066
self.assertEqual(expected, osutils.splitpath(path))
1069
check(['a', 'b'], 'a/b')
1070
check(['a', 'b'], 'a/./b')
1071
check(['a', '.b'], 'a/.b')
1072
check(['a', '.b'], 'a\\.b')
1074
self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
1077
class TestParentDirectories(tests.TestCaseInTempDir):
1078
"""Test osutils.parent_directories()"""
1080
def test_parent_directories(self):
1081
self.assertEqual([], osutils.parent_directories('a'))
1082
self.assertEqual(['a'], osutils.parent_directories('a/b'))
1083
self.assertEqual(['a/b', 'a'], osutils.parent_directories('a/b/c'))
1086
class TestMacFuncsDirs(tests.TestCaseInTempDir):
1087
"""Test mac special functions that require directories."""
1089
def test_getcwd(self):
1090
self.requireFeature(features.UnicodeFilenameFeature)
1091
os.mkdir(u'B\xe5gfors')
1092
os.chdir(u'B\xe5gfors')
1093
self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
1095
def test_getcwd_nonnorm(self):
1096
self.requireFeature(features.UnicodeFilenameFeature)
1097
# Test that _mac_getcwd() will normalize this path
1098
os.mkdir(u'Ba\u030agfors')
1099
os.chdir(u'Ba\u030agfors')
1100
self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
1103
class TestChunksToLines(tests.TestCase):
1105
def test_smoketest(self):
1106
self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
1107
osutils.chunks_to_lines(['foo\nbar', '\nbaz\n']))
1108
self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
1109
osutils.chunks_to_lines(['foo\n', 'bar\n', 'baz\n']))
1111
def test_osutils_binding(self):
1112
from bzrlib.tests import test__chunks_to_lines
1113
if test__chunks_to_lines.compiled_chunkstolines_feature.available():
1114
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1116
from bzrlib._chunks_to_lines_py import chunks_to_lines
1117
self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
1120
class TestSplitLines(tests.TestCase):
1122
def test_split_unicode(self):
1123
self.assertEqual([u'foo\n', u'bar\xae'],
1124
osutils.split_lines(u'foo\nbar\xae'))
1125
self.assertEqual([u'foo\n', u'bar\xae\n'],
1126
osutils.split_lines(u'foo\nbar\xae\n'))
1128
def test_split_with_carriage_returns(self):
1129
self.assertEqual(['foo\rbar\n'],
1130
osutils.split_lines('foo\rbar\n'))
1133
class TestWalkDirs(tests.TestCaseInTempDir):
1135
def assertExpectedBlocks(self, expected, result):
1136
self.assertEqual(expected,
1137
[(dirinfo, [line[0:3] for line in block])
1138
for dirinfo, block in result])
1140
def test_walkdirs(self):
1149
self.build_tree(tree)
1150
expected_dirblocks = [
1152
[('0file', '0file', 'file'),
1153
('1dir', '1dir', 'directory'),
1154
('2file', '2file', 'file'),
1157
(('1dir', './1dir'),
1158
[('1dir/0file', '0file', 'file'),
1159
('1dir/1dir', '1dir', 'directory'),
1162
(('1dir/1dir', './1dir/1dir'),
1168
found_bzrdir = False
1169
for dirdetail, dirblock in osutils.walkdirs('.'):
1170
if len(dirblock) and dirblock[0][1] == '.bzr':
1171
# this tests the filtering of selected paths
1174
result.append((dirdetail, dirblock))
1176
self.assertTrue(found_bzrdir)
1177
self.assertExpectedBlocks(expected_dirblocks, result)
1178
# you can search a subdir only, with a supplied prefix.
1180
for dirblock in osutils.walkdirs('./1dir', '1dir'):
1181
result.append(dirblock)
1182
self.assertExpectedBlocks(expected_dirblocks[1:], result)
1184
def test_walkdirs_os_error(self):
1185
# <https://bugs.launchpad.net/bzr/+bug/338653>
1186
# Pyrex readdir didn't raise useful messages if it had an error
1187
# reading the directory
1188
if sys.platform == 'win32':
1189
raise tests.TestNotApplicable(
1190
"readdir IOError not tested on win32")
1191
self.requireFeature(features.not_running_as_root)
1192
os.mkdir("test-unreadable")
1193
os.chmod("test-unreadable", 0000)
1194
# must chmod it back so that it can be removed
1195
self.addCleanup(os.chmod, "test-unreadable", 0700)
1196
# The error is not raised until the generator is actually evaluated.
1197
# (It would be ok if it happened earlier but at the moment it
1199
e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
1200
self.assertEquals('./test-unreadable', e.filename)
1201
self.assertEquals(errno.EACCES, e.errno)
1202
# Ensure the message contains the file name
1203
self.assertContainsRe(str(e), "\./test-unreadable")
1206
def test_walkdirs_encoding_error(self):
1207
# <https://bugs.launchpad.net/bzr/+bug/488519>
1208
# walkdirs didn't raise a useful message when the filenames
1209
# are not using the filesystem's encoding
1211
# require a bytestring based filesystem
1212
self.requireFeature(features.ByteStringNamedFilesystem)
1223
self.build_tree(tree)
1225
# rename the 1file to a latin-1 filename
1226
os.rename("./1file", "\xe8file")
1227
if "\xe8file" not in os.listdir("."):
1228
self.skip("Lack filesystem that preserves arbitrary bytes")
1230
self._save_platform_info()
1231
win32utils.winver = None # Avoid the win32 detection code
1232
osutils._fs_enc = 'UTF-8'
1234
# this should raise on error
1236
for dirdetail, dirblock in osutils.walkdirs('.'):
1239
self.assertRaises(errors.BadFilenameEncoding, attempt)
1241
def test__walkdirs_utf8(self):
1250
self.build_tree(tree)
1251
expected_dirblocks = [
1253
[('0file', '0file', 'file'),
1254
('1dir', '1dir', 'directory'),
1255
('2file', '2file', 'file'),
1258
(('1dir', './1dir'),
1259
[('1dir/0file', '0file', 'file'),
1260
('1dir/1dir', '1dir', 'directory'),
1263
(('1dir/1dir', './1dir/1dir'),
1269
found_bzrdir = False
1270
for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
1271
if len(dirblock) and dirblock[0][1] == '.bzr':
1272
# this tests the filtering of selected paths
1275
result.append((dirdetail, dirblock))
1277
self.assertTrue(found_bzrdir)
1278
self.assertExpectedBlocks(expected_dirblocks, result)
1280
# you can search a subdir only, with a supplied prefix.
1282
for dirblock in osutils.walkdirs('./1dir', '1dir'):
1283
result.append(dirblock)
1284
self.assertExpectedBlocks(expected_dirblocks[1:], result)
1286
def _filter_out_stat(self, result):
1287
"""Filter out the stat value from the walkdirs result"""
1288
for dirdetail, dirblock in result:
1290
for info in dirblock:
1291
# Ignore info[3] which is the stat
1292
new_dirblock.append((info[0], info[1], info[2], info[4]))
1293
dirblock[:] = new_dirblock
1295
def _save_platform_info(self):
1296
self.overrideAttr(win32utils, 'winver')
1297
self.overrideAttr(osutils, '_fs_enc')
1298
self.overrideAttr(osutils, '_selected_dir_reader')
1300
def assertDirReaderIs(self, expected):
1301
"""Assert the right implementation for _walkdirs_utf8 is chosen."""
1302
# Force it to redetect
1303
osutils._selected_dir_reader = None
1304
# Nothing to list, but should still trigger the selection logic
1305
self.assertEqual([(('', '.'), [])], list(osutils._walkdirs_utf8('.')))
1306
self.assertIsInstance(osutils._selected_dir_reader, expected)
1308
def test_force_walkdirs_utf8_fs_utf8(self):
1309
self.requireFeature(UTF8DirReaderFeature)
1310
self._save_platform_info()
1311
win32utils.winver = None # Avoid the win32 detection code
1312
osutils._fs_enc = 'utf-8'
1313
self.assertDirReaderIs(
1314
UTF8DirReaderFeature.module.UTF8DirReader)
1316
def test_force_walkdirs_utf8_fs_ascii(self):
1317
self.requireFeature(UTF8DirReaderFeature)
1318
self._save_platform_info()
1319
win32utils.winver = None # Avoid the win32 detection code
1320
osutils._fs_enc = 'ascii'
1321
self.assertDirReaderIs(
1322
UTF8DirReaderFeature.module.UTF8DirReader)
1324
def test_force_walkdirs_utf8_fs_latin1(self):
1325
self._save_platform_info()
1326
win32utils.winver = None # Avoid the win32 detection code
1327
osutils._fs_enc = 'iso-8859-1'
1328
self.assertDirReaderIs(osutils.UnicodeDirReader)
1330
def test_force_walkdirs_utf8_nt(self):
1331
# Disabled because the thunk of the whole walkdirs api is disabled.
1332
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1333
self._save_platform_info()
1334
win32utils.winver = 'Windows NT'
1335
from bzrlib._walkdirs_win32 import Win32ReadDir
1336
self.assertDirReaderIs(Win32ReadDir)
1338
def test_force_walkdirs_utf8_98(self):
1339
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1340
self._save_platform_info()
1341
win32utils.winver = 'Windows 98'
1342
self.assertDirReaderIs(osutils.UnicodeDirReader)
1344
def test_unicode_walkdirs(self):
1345
"""Walkdirs should always return unicode paths."""
1346
self.requireFeature(features.UnicodeFilenameFeature)
1347
name0 = u'0file-\xb6'
1348
name1 = u'1dir-\u062c\u0648'
1349
name2 = u'2file-\u0633'
1353
name1 + '/' + name0,
1354
name1 + '/' + name1 + '/',
1357
self.build_tree(tree)
1358
expected_dirblocks = [
1360
[(name0, name0, 'file', './' + name0),
1361
(name1, name1, 'directory', './' + name1),
1362
(name2, name2, 'file', './' + name2),
1365
((name1, './' + name1),
1366
[(name1 + '/' + name0, name0, 'file', './' + name1
1368
(name1 + '/' + name1, name1, 'directory', './' + name1
1372
((name1 + '/' + name1, './' + name1 + '/' + name1),
1377
result = list(osutils.walkdirs('.'))
1378
self._filter_out_stat(result)
1379
self.assertEqual(expected_dirblocks, result)
1380
result = list(osutils.walkdirs(u'./'+name1, name1))
1381
self._filter_out_stat(result)
1382
self.assertEqual(expected_dirblocks[1:], result)
1384
def test_unicode__walkdirs_utf8(self):
1385
"""Walkdirs_utf8 should always return utf8 paths.
1387
The abspath portion might be in unicode or utf-8
1389
self.requireFeature(features.UnicodeFilenameFeature)
1390
name0 = u'0file-\xb6'
1391
name1 = u'1dir-\u062c\u0648'
1392
name2 = u'2file-\u0633'
1396
name1 + '/' + name0,
1397
name1 + '/' + name1 + '/',
1400
self.build_tree(tree)
1401
name0 = name0.encode('utf8')
1402
name1 = name1.encode('utf8')
1403
name2 = name2.encode('utf8')
1405
expected_dirblocks = [
1407
[(name0, name0, 'file', './' + name0),
1408
(name1, name1, 'directory', './' + name1),
1409
(name2, name2, 'file', './' + name2),
1412
((name1, './' + name1),
1413
[(name1 + '/' + name0, name0, 'file', './' + name1
1415
(name1 + '/' + name1, name1, 'directory', './' + name1
1419
((name1 + '/' + name1, './' + name1 + '/' + name1),
1425
# For ease in testing, if walkdirs_utf8 returns Unicode, assert that
1426
# all abspaths are Unicode, and encode them back into utf8.
1427
for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
1428
self.assertIsInstance(dirdetail[0], str)
1429
if isinstance(dirdetail[1], unicode):
1430
dirdetail = (dirdetail[0], dirdetail[1].encode('utf8'))
1431
dirblock = [list(info) for info in dirblock]
1432
for info in dirblock:
1433
self.assertIsInstance(info[4], unicode)
1434
info[4] = info[4].encode('utf8')
1436
for info in dirblock:
1437
self.assertIsInstance(info[0], str)
1438
self.assertIsInstance(info[1], str)
1439
self.assertIsInstance(info[4], str)
1440
# Remove the stat information
1441
new_dirblock.append((info[0], info[1], info[2], info[4]))
1442
result.append((dirdetail, new_dirblock))
1443
self.assertEqual(expected_dirblocks, result)
1445
def test__walkdirs_utf8_with_unicode_fs(self):
1446
"""UnicodeDirReader should be a safe fallback everywhere
1448
The abspath portion should be in unicode
1450
self.requireFeature(features.UnicodeFilenameFeature)
1451
# Use the unicode reader. TODO: split into driver-and-driven unit
1453
self._save_platform_info()
1454
osutils._selected_dir_reader = osutils.UnicodeDirReader()
1455
name0u = u'0file-\xb6'
1456
name1u = u'1dir-\u062c\u0648'
1457
name2u = u'2file-\u0633'
1461
name1u + '/' + name0u,
1462
name1u + '/' + name1u + '/',
1465
self.build_tree(tree)
1466
name0 = name0u.encode('utf8')
1467
name1 = name1u.encode('utf8')
1468
name2 = name2u.encode('utf8')
1470
# All of the abspaths should be in unicode, all of the relative paths
1472
expected_dirblocks = [
1474
[(name0, name0, 'file', './' + name0u),
1475
(name1, name1, 'directory', './' + name1u),
1476
(name2, name2, 'file', './' + name2u),
1479
((name1, './' + name1u),
1480
[(name1 + '/' + name0, name0, 'file', './' + name1u
1482
(name1 + '/' + name1, name1, 'directory', './' + name1u
1486
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1491
result = list(osutils._walkdirs_utf8('.'))
1492
self._filter_out_stat(result)
1493
self.assertEqual(expected_dirblocks, result)
1495
def test__walkdirs_utf8_win32readdir(self):
1496
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1497
self.requireFeature(features.UnicodeFilenameFeature)
1498
from bzrlib._walkdirs_win32 import Win32ReadDir
1499
self._save_platform_info()
1500
osutils._selected_dir_reader = Win32ReadDir()
1501
name0u = u'0file-\xb6'
1502
name1u = u'1dir-\u062c\u0648'
1503
name2u = u'2file-\u0633'
1507
name1u + '/' + name0u,
1508
name1u + '/' + name1u + '/',
1511
self.build_tree(tree)
1512
name0 = name0u.encode('utf8')
1513
name1 = name1u.encode('utf8')
1514
name2 = name2u.encode('utf8')
1516
# All of the abspaths should be in unicode, all of the relative paths
1518
expected_dirblocks = [
1520
[(name0, name0, 'file', './' + name0u),
1521
(name1, name1, 'directory', './' + name1u),
1522
(name2, name2, 'file', './' + name2u),
1525
((name1, './' + name1u),
1526
[(name1 + '/' + name0, name0, 'file', './' + name1u
1528
(name1 + '/' + name1, name1, 'directory', './' + name1u
1532
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1537
result = list(osutils._walkdirs_utf8(u'.'))
1538
self._filter_out_stat(result)
1539
self.assertEqual(expected_dirblocks, result)
1541
def assertStatIsCorrect(self, path, win32stat):
1542
os_stat = os.stat(path)
1543
self.assertEqual(os_stat.st_size, win32stat.st_size)
1544
self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
1545
self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
1546
self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
1547
self.assertEqual(os_stat.st_dev, win32stat.st_dev)
1548
self.assertEqual(os_stat.st_ino, win32stat.st_ino)
1549
self.assertEqual(os_stat.st_mode, win32stat.st_mode)
1551
def test__walkdirs_utf_win32_find_file_stat_file(self):
1552
"""make sure our Stat values are valid"""
1553
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1554
self.requireFeature(features.UnicodeFilenameFeature)
1555
from bzrlib._walkdirs_win32 import Win32ReadDir
1556
name0u = u'0file-\xb6'
1557
name0 = name0u.encode('utf8')
1558
self.build_tree([name0u])
1559
# I hate to sleep() here, but I'm trying to make the ctime different
1562
f = open(name0u, 'ab')
1564
f.write('just a small update')
1568
result = Win32ReadDir().read_dir('', u'.')
1570
self.assertEqual((name0, name0, 'file'), entry[:3])
1571
self.assertEqual(u'./' + name0u, entry[4])
1572
self.assertStatIsCorrect(entry[4], entry[3])
1573
self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
1575
def test__walkdirs_utf_win32_find_file_stat_directory(self):
1576
"""make sure our Stat values are valid"""
1577
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1578
self.requireFeature(features.UnicodeFilenameFeature)
1579
from bzrlib._walkdirs_win32 import Win32ReadDir
1580
name0u = u'0dir-\u062c\u0648'
1581
name0 = name0u.encode('utf8')
1582
self.build_tree([name0u + '/'])
1584
result = Win32ReadDir().read_dir('', u'.')
1586
self.assertEqual((name0, name0, 'directory'), entry[:3])
1587
self.assertEqual(u'./' + name0u, entry[4])
1588
self.assertStatIsCorrect(entry[4], entry[3])
1590
def assertPathCompare(self, path_less, path_greater):
1591
"""check that path_less and path_greater compare correctly."""
1592
self.assertEqual(0, osutils.compare_paths_prefix_order(
1593
path_less, path_less))
1594
self.assertEqual(0, osutils.compare_paths_prefix_order(
1595
path_greater, path_greater))
1596
self.assertEqual(-1, osutils.compare_paths_prefix_order(
1597
path_less, path_greater))
1598
self.assertEqual(1, osutils.compare_paths_prefix_order(
1599
path_greater, path_less))
1601
def test_compare_paths_prefix_order(self):
1602
# root before all else
1603
self.assertPathCompare("/", "/a")
1604
# alpha within a dir
1605
self.assertPathCompare("/a", "/b")
1606
self.assertPathCompare("/b", "/z")
1607
# high dirs before lower.
1608
self.assertPathCompare("/z", "/a/a")
1609
# except if the deeper dir should be output first
1610
self.assertPathCompare("/a/b/c", "/d/g")
1611
# lexical betwen dirs of the same height
1612
self.assertPathCompare("/a/z", "/z/z")
1613
self.assertPathCompare("/a/c/z", "/a/d/e")
1615
# this should also be consistent for no leading / paths
1616
# root before all else
1617
self.assertPathCompare("", "a")
1618
# alpha within a dir
1619
self.assertPathCompare("a", "b")
1620
self.assertPathCompare("b", "z")
1621
# high dirs before lower.
1622
self.assertPathCompare("z", "a/a")
1623
# except if the deeper dir should be output first
1624
self.assertPathCompare("a/b/c", "d/g")
1625
# lexical betwen dirs of the same height
1626
self.assertPathCompare("a/z", "z/z")
1627
self.assertPathCompare("a/c/z", "a/d/e")
1629
def test_path_prefix_sorting(self):
1630
"""Doing a sort on path prefix should match our sample data."""
1645
dir_sorted_paths = [
1661
sorted(original_paths, key=osutils.path_prefix_key))
1662
# using the comparison routine shoudl work too:
1665
sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
1668
class TestCopyTree(tests.TestCaseInTempDir):
1670
def test_copy_basic_tree(self):
1671
self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1672
osutils.copy_tree('source', 'target')
1673
self.assertEqual(['a', 'b'], sorted(os.listdir('target')))
1674
self.assertEqual(['c'], os.listdir('target/b'))
1676
def test_copy_tree_target_exists(self):
1677
self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c',
1679
osutils.copy_tree('source', 'target')
1680
self.assertEqual(['a', 'b'], sorted(os.listdir('target')))
1681
self.assertEqual(['c'], os.listdir('target/b'))
1683
def test_copy_tree_symlinks(self):
1684
self.requireFeature(features.SymlinkFeature)
1685
self.build_tree(['source/'])
1686
os.symlink('a/generic/path', 'source/lnk')
1687
osutils.copy_tree('source', 'target')
1688
self.assertEqual(['lnk'], os.listdir('target'))
1689
self.assertEqual('a/generic/path', os.readlink('target/lnk'))
1691
def test_copy_tree_handlers(self):
1692
processed_files = []
1693
processed_links = []
1694
def file_handler(from_path, to_path):
1695
processed_files.append(('f', from_path, to_path))
1696
def dir_handler(from_path, to_path):
1697
processed_files.append(('d', from_path, to_path))
1698
def link_handler(from_path, to_path):
1699
processed_links.append((from_path, to_path))
1700
handlers = {'file':file_handler,
1701
'directory':dir_handler,
1702
'symlink':link_handler,
1705
self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1706
if osutils.has_symlinks():
1707
os.symlink('a/generic/path', 'source/lnk')
1708
osutils.copy_tree('source', 'target', handlers=handlers)
1710
self.assertEqual([('d', 'source', 'target'),
1711
('f', 'source/a', 'target/a'),
1712
('d', 'source/b', 'target/b'),
1713
('f', 'source/b/c', 'target/b/c'),
1715
self.assertPathDoesNotExist('target')
1716
if osutils.has_symlinks():
1717
self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1720
class TestSetUnsetEnv(tests.TestCase):
1721
"""Test updating the environment"""
1724
super(TestSetUnsetEnv, self).setUp()
1726
self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'),
1727
'Environment was not cleaned up properly.'
1728
' Variable BZR_TEST_ENV_VAR should not exist.')
1730
if 'BZR_TEST_ENV_VAR' in os.environ:
1731
del os.environ['BZR_TEST_ENV_VAR']
1732
self.addCleanup(cleanup)
1735
"""Test that we can set an env variable"""
1736
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
1737
self.assertEqual(None, old)
1738
self.assertEqual('foo', os.environ.get('BZR_TEST_ENV_VAR'))
1740
def test_double_set(self):
1741
"""Test that we get the old value out"""
1742
osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
1743
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'bar')
1744
self.assertEqual('foo', old)
1745
self.assertEqual('bar', os.environ.get('BZR_TEST_ENV_VAR'))
1747
def test_unicode(self):
1748
"""Environment can only contain plain strings
1750
So Unicode strings must be encoded.
1752
uni_val, env_val = tests.probe_unicode_in_user_encoding()
1754
raise tests.TestSkipped(
1755
'Cannot find a unicode character that works in encoding %s'
1756
% (osutils.get_user_encoding(),))
1758
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
1759
self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
1761
def test_unset(self):
1762
"""Test that passing None will remove the env var"""
1763
osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
1764
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1765
self.assertEqual('foo', old)
1766
self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1767
self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1770
class TestSizeShaFile(tests.TestCaseInTempDir):
1772
def test_sha_empty(self):
1773
self.build_tree_contents([('foo', '')])
1774
expected_sha = osutils.sha_string('')
1776
self.addCleanup(f.close)
1777
size, sha = osutils.size_sha_file(f)
1778
self.assertEqual(0, size)
1779
self.assertEqual(expected_sha, sha)
1781
def test_sha_mixed_endings(self):
1782
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1783
self.build_tree_contents([('foo', text)])
1784
expected_sha = osutils.sha_string(text)
1785
f = open('foo', 'rb')
1786
self.addCleanup(f.close)
1787
size, sha = osutils.size_sha_file(f)
1788
self.assertEqual(38, size)
1789
self.assertEqual(expected_sha, sha)
1792
class TestShaFileByName(tests.TestCaseInTempDir):
1794
def test_sha_empty(self):
1795
self.build_tree_contents([('foo', '')])
1796
expected_sha = osutils.sha_string('')
1797
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1799
def test_sha_mixed_endings(self):
1800
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1801
self.build_tree_contents([('foo', text)])
1802
expected_sha = osutils.sha_string(text)
1803
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1806
class TestResourceLoading(tests.TestCaseInTempDir):
1808
def test_resource_string(self):
1809
# test resource in bzrlib
1810
text = osutils.resource_string('bzrlib', 'debug.py')
1811
self.assertContainsRe(text, "debug_flags = set()")
1812
# test resource under bzrlib
1813
text = osutils.resource_string('bzrlib.ui', 'text.py')
1814
self.assertContainsRe(text, "class TextUIFactory")
1815
# test unsupported package
1816
self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
1818
# test unknown resource
1819
self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
1822
class TestReCompile(tests.TestCase):
1824
def _deprecated_re_compile_checked(self, *args, **kwargs):
1825
return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1826
osutils.re_compile_checked, *args, **kwargs)
1828
def test_re_compile_checked(self):
1829
r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1830
self.assertTrue(r.match('aaaa'))
1831
self.assertTrue(r.match('aAaA'))
1833
def test_re_compile_checked_error(self):
1834
# like https://bugs.launchpad.net/bzr/+bug/251352
1836
# Due to possible test isolation error, re.compile is not lazy at
1837
# this point. We re-install lazy compile.
1838
lazy_regex.install_lazy_compile()
1839
err = self.assertRaises(
1840
errors.BzrCommandError,
1841
self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1843
'Invalid regular expression in test case: '
1844
'"*" nothing to repeat',
1848
class TestDirReader(tests.TestCaseInTempDir):
1850
scenarios = dir_reader_scenarios()
1853
_dir_reader_class = None
1854
_native_to_unicode = None
1857
super(TestDirReader, self).setUp()
1858
self.overrideAttr(osutils,
1859
'_selected_dir_reader', self._dir_reader_class())
1861
def _get_ascii_tree(self):
1869
expected_dirblocks = [
1871
[('0file', '0file', 'file'),
1872
('1dir', '1dir', 'directory'),
1873
('2file', '2file', 'file'),
1876
(('1dir', './1dir'),
1877
[('1dir/0file', '0file', 'file'),
1878
('1dir/1dir', '1dir', 'directory'),
1881
(('1dir/1dir', './1dir/1dir'),
1886
return tree, expected_dirblocks
1888
def test_walk_cur_dir(self):
1889
tree, expected_dirblocks = self._get_ascii_tree()
1890
self.build_tree(tree)
1891
result = list(osutils._walkdirs_utf8('.'))
1892
# Filter out stat and abspath
1893
self.assertEqual(expected_dirblocks,
1894
[(dirinfo, [line[0:3] for line in block])
1895
for dirinfo, block in result])
1897
def test_walk_sub_dir(self):
1898
tree, expected_dirblocks = self._get_ascii_tree()
1899
self.build_tree(tree)
1900
# you can search a subdir only, with a supplied prefix.
1901
result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
1902
# Filter out stat and abspath
1903
self.assertEqual(expected_dirblocks[1:],
1904
[(dirinfo, [line[0:3] for line in block])
1905
for dirinfo, block in result])
1907
def _get_unicode_tree(self):
1908
name0u = u'0file-\xb6'
1909
name1u = u'1dir-\u062c\u0648'
1910
name2u = u'2file-\u0633'
1914
name1u + '/' + name0u,
1915
name1u + '/' + name1u + '/',
1918
name0 = name0u.encode('UTF-8')
1919
name1 = name1u.encode('UTF-8')
1920
name2 = name2u.encode('UTF-8')
1921
expected_dirblocks = [
1923
[(name0, name0, 'file', './' + name0u),
1924
(name1, name1, 'directory', './' + name1u),
1925
(name2, name2, 'file', './' + name2u),
1928
((name1, './' + name1u),
1929
[(name1 + '/' + name0, name0, 'file', './' + name1u
1931
(name1 + '/' + name1, name1, 'directory', './' + name1u
1935
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1940
return tree, expected_dirblocks
1942
def _filter_out(self, raw_dirblocks):
1943
"""Filter out a walkdirs_utf8 result.
1945
stat field is removed, all native paths are converted to unicode
1947
filtered_dirblocks = []
1948
for dirinfo, block in raw_dirblocks:
1949
dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
1952
details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
1953
filtered_dirblocks.append((dirinfo, details))
1954
return filtered_dirblocks
1956
def test_walk_unicode_tree(self):
1957
self.requireFeature(features.UnicodeFilenameFeature)
1958
tree, expected_dirblocks = self._get_unicode_tree()
1959
self.build_tree(tree)
1960
result = list(osutils._walkdirs_utf8('.'))
1961
self.assertEqual(expected_dirblocks, self._filter_out(result))
1963
def test_symlink(self):
1964
self.requireFeature(features.SymlinkFeature)
1965
self.requireFeature(features.UnicodeFilenameFeature)
1966
target = u'target\N{Euro Sign}'
1967
link_name = u'l\N{Euro Sign}nk'
1968
os.symlink(target, link_name)
1969
target_utf8 = target.encode('UTF-8')
1970
link_name_utf8 = link_name.encode('UTF-8')
1971
expected_dirblocks = [
1973
[(link_name_utf8, link_name_utf8,
1974
'symlink', './' + link_name),],
1976
result = list(osutils._walkdirs_utf8('.'))
1977
self.assertEqual(expected_dirblocks, self._filter_out(result))
1980
class TestReadLink(tests.TestCaseInTempDir):
1981
"""Exposes os.readlink() problems and the osutils solution.
1983
The only guarantee offered by os.readlink(), starting with 2.6, is that a
1984
unicode string will be returned if a unicode string is passed.
1986
But prior python versions failed to properly encode the passed unicode
1989
_test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
1992
super(tests.TestCaseInTempDir, self).setUp()
1993
self.link = u'l\N{Euro Sign}ink'
1994
self.target = u'targe\N{Euro Sign}t'
1995
os.symlink(self.target, self.link)
1997
def test_os_readlink_link_encoding(self):
1998
self.assertEquals(self.target, os.readlink(self.link))
2000
def test_os_readlink_link_decoding(self):
2001
self.assertEquals(self.target.encode(osutils._fs_enc),
2002
os.readlink(self.link.encode(osutils._fs_enc)))
2005
class TestConcurrency(tests.TestCase):
2008
super(TestConcurrency, self).setUp()
2009
self.overrideAttr(osutils, '_cached_local_concurrency')
2011
def test_local_concurrency(self):
2012
concurrency = osutils.local_concurrency()
2013
self.assertIsInstance(concurrency, int)
2015
def test_local_concurrency_environment_variable(self):
2016
self.overrideEnv('BZR_CONCURRENCY', '2')
2017
self.assertEqual(2, osutils.local_concurrency(use_cache=False))
2018
self.overrideEnv('BZR_CONCURRENCY', '3')
2019
self.assertEqual(3, osutils.local_concurrency(use_cache=False))
2020
self.overrideEnv('BZR_CONCURRENCY', 'foo')
2021
self.assertEqual(1, osutils.local_concurrency(use_cache=False))
2023
def test_option_concurrency(self):
2024
self.overrideEnv('BZR_CONCURRENCY', '1')
2025
self.run_bzr('rocks --concurrency 42')
2026
# Command line overrides environment variable
2027
self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
2028
self.assertEquals(42, osutils.local_concurrency(use_cache=False))
2031
class TestFailedToLoadExtension(tests.TestCase):
2033
def _try_loading(self):
2035
import bzrlib._fictional_extension_py
2036
except ImportError, e:
2037
osutils.failed_to_load_extension(e)
2041
super(TestFailedToLoadExtension, self).setUp()
2042
self.overrideAttr(osutils, '_extension_load_failures', [])
2044
def test_failure_to_load(self):
2046
self.assertLength(1, osutils._extension_load_failures)
2047
self.assertEquals(osutils._extension_load_failures[0],
2048
"No module named _fictional_extension_py")
2050
def test_report_extension_load_failures_no_warning(self):
2051
self.assertTrue(self._try_loading())
2052
warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
2053
# it used to give a Python warning; it no longer does
2054
self.assertLength(0, warnings)
2056
def test_report_extension_load_failures_message(self):
2058
trace.push_log_file(log)
2059
self.assertTrue(self._try_loading())
2060
osutils.report_extension_load_failures()
2061
self.assertContainsRe(
2063
r"bzr: warning: some compiled extensions could not be loaded; "
2064
"see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
2068
class TestTerminalWidth(tests.TestCase):
2071
super(TestTerminalWidth, self).setUp()
2072
self._orig_terminal_size_state = osutils._terminal_size_state
2073
self._orig_first_terminal_size = osutils._first_terminal_size
2074
self.addCleanup(self.restore_osutils_globals)
2075
osutils._terminal_size_state = 'no_data'
2076
osutils._first_terminal_size = None
2078
def restore_osutils_globals(self):
2079
osutils._terminal_size_state = self._orig_terminal_size_state
2080
osutils._first_terminal_size = self._orig_first_terminal_size
2082
def replace_stdout(self, new):
2083
self.overrideAttr(sys, 'stdout', new)
2085
def replace__terminal_size(self, new):
2086
self.overrideAttr(osutils, '_terminal_size', new)
2088
def set_fake_tty(self):
2090
class I_am_a_tty(object):
2094
self.replace_stdout(I_am_a_tty())
2096
def test_default_values(self):
2097
self.assertEqual(80, osutils.default_terminal_width)
2099
def test_defaults_to_BZR_COLUMNS(self):
2100
# BZR_COLUMNS is set by the test framework
2101
self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
2102
self.overrideEnv('BZR_COLUMNS', '12')
2103
self.assertEqual(12, osutils.terminal_width())
2105
def test_BZR_COLUMNS_0_no_limit(self):
2106
self.overrideEnv('BZR_COLUMNS', '0')
2107
self.assertEqual(None, osutils.terminal_width())
2109
def test_falls_back_to_COLUMNS(self):
2110
self.overrideEnv('BZR_COLUMNS', None)
2111
self.assertNotEqual('42', os.environ['COLUMNS'])
2113
self.overrideEnv('COLUMNS', '42')
2114
self.assertEqual(42, osutils.terminal_width())
2116
def test_tty_default_without_columns(self):
2117
self.overrideEnv('BZR_COLUMNS', None)
2118
self.overrideEnv('COLUMNS', None)
2120
def terminal_size(w, h):
2124
# We need to override the osutils definition as it depends on the
2125
# running environment that we can't control (PQM running without a
2126
# controlling terminal is one example).
2127
self.replace__terminal_size(terminal_size)
2128
self.assertEqual(42, osutils.terminal_width())
2130
def test_non_tty_default_without_columns(self):
2131
self.overrideEnv('BZR_COLUMNS', None)
2132
self.overrideEnv('COLUMNS', None)
2133
self.replace_stdout(None)
2134
self.assertEqual(None, osutils.terminal_width())
2136
def test_no_TIOCGWINSZ(self):
2137
self.requireFeature(term_ios_feature)
2138
termios = term_ios_feature.module
2139
# bug 63539 is about a termios without TIOCGWINSZ attribute
2141
orig = termios.TIOCGWINSZ
2142
except AttributeError:
2143
# We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
2146
self.overrideAttr(termios, 'TIOCGWINSZ')
2147
del termios.TIOCGWINSZ
2148
self.overrideEnv('BZR_COLUMNS', None)
2149
self.overrideEnv('COLUMNS', None)
2150
# Whatever the result is, if we don't raise an exception, it's ok.
2151
osutils.terminal_width()
2154
class TestCreationOps(tests.TestCaseInTempDir):
2155
_test_needs_features = [features.chown_feature]
2158
super(TestCreationOps, self).setUp()
2159
self.overrideAttr(os, 'chown', self._dummy_chown)
2161
# params set by call to _dummy_chown
2162
self.path = self.uid = self.gid = None
2164
def _dummy_chown(self, path, uid, gid):
2165
self.path, self.uid, self.gid = path, uid, gid
2167
def test_copy_ownership_from_path(self):
2168
"""copy_ownership_from_path test with specified src."""
2170
f = open('test_file', 'wt')
2171
osutils.copy_ownership_from_path('test_file', ownsrc)
2174
self.assertEquals(self.path, 'test_file')
2175
self.assertEquals(self.uid, s.st_uid)
2176
self.assertEquals(self.gid, s.st_gid)
2178
def test_copy_ownership_nonesrc(self):
2179
"""copy_ownership_from_path test with src=None."""
2180
f = open('test_file', 'wt')
2181
# should use parent dir for permissions
2182
osutils.copy_ownership_from_path('test_file')
2185
self.assertEquals(self.path, 'test_file')
2186
self.assertEquals(self.uid, s.st_uid)
2187
self.assertEquals(self.gid, s.st_gid)
2190
class TestPathFromEnviron(tests.TestCase):
2192
def test_is_unicode(self):
2193
self.overrideEnv('BZR_TEST_PATH', './anywhere at all/')
2194
path = osutils.path_from_environ('BZR_TEST_PATH')
2195
self.assertIsInstance(path, unicode)
2196
self.assertEqual(u'./anywhere at all/', path)
2198
def test_posix_path_env_ascii(self):
2199
self.overrideEnv('BZR_TEST_PATH', '/tmp')
2200
home = osutils._posix_path_from_environ('BZR_TEST_PATH')
2201
self.assertIsInstance(home, unicode)
2202
self.assertEqual(u'/tmp', home)
2204
def test_posix_path_env_unicode(self):
2205
self.requireFeature(features.ByteStringNamedFilesystem)
2206
self.overrideEnv('BZR_TEST_PATH', '/home/\xa7test')
2207
self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
2208
self.assertEqual(u'/home/\xa7test',
2209
osutils._posix_path_from_environ('BZR_TEST_PATH'))
2210
osutils._fs_enc = "iso8859-5"
2211
self.assertEqual(u'/home/\u0407test',
2212
osutils._posix_path_from_environ('BZR_TEST_PATH'))
2213
osutils._fs_enc = "utf-8"
2214
self.assertRaises(errors.BadFilenameEncoding,
2215
osutils._posix_path_from_environ, 'BZR_TEST_PATH')
2218
class TestGetHomeDir(tests.TestCase):
2220
def test_is_unicode(self):
2221
home = osutils._get_home_dir()
2222
self.assertIsInstance(home, unicode)
2224
def test_posix_homeless(self):
2225
self.overrideEnv('HOME', None)
2226
home = osutils._get_home_dir()
2227
self.assertIsInstance(home, unicode)
2229
def test_posix_home_ascii(self):
2230
self.overrideEnv('HOME', '/home/test')
2231
home = osutils._posix_get_home_dir()
2232
self.assertIsInstance(home, unicode)
2233
self.assertEqual(u'/home/test', home)
2235
def test_posix_home_unicode(self):
2236
self.requireFeature(features.ByteStringNamedFilesystem)
2237
self.overrideEnv('HOME', '/home/\xa7test')
2238
self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
2239
self.assertEqual(u'/home/\xa7test', osutils._posix_get_home_dir())
2240
osutils._fs_enc = "iso8859-5"
2241
self.assertEqual(u'/home/\u0407test', osutils._posix_get_home_dir())
2242
osutils._fs_enc = "utf-8"
2243
self.assertRaises(errors.BadFilenameEncoding,
2244
osutils._posix_get_home_dir)
2247
class TestGetuserUnicode(tests.TestCase):
2249
def test_is_unicode(self):
2250
user = osutils.getuser_unicode()
2251
self.assertIsInstance(user, unicode)
2253
def envvar_to_override(self):
2254
if sys.platform == "win32":
2255
# Disable use of platform calls on windows so envvar is used
2256
self.overrideAttr(win32utils, 'has_ctypes', False)
2257
return 'USERNAME' # only variable used on windows
2258
return 'LOGNAME' # first variable checked by getpass.getuser()
2260
def test_ascii_user(self):
2261
self.overrideEnv(self.envvar_to_override(), 'jrandom')
2262
self.assertEqual(u'jrandom', osutils.getuser_unicode())
2264
def test_unicode_user(self):
2265
ue = osutils.get_user_encoding()
2266
uni_val, env_val = tests.probe_unicode_in_user_encoding()
2268
raise tests.TestSkipped(
2269
'Cannot find a unicode character that works in encoding %s'
2270
% (osutils.get_user_encoding(),))
2271
uni_username = u'jrandom' + uni_val
2272
encoded_username = uni_username.encode(ue)
2273
self.overrideEnv(self.envvar_to_override(), encoded_username)
2274
self.assertEqual(uni_username, osutils.getuser_unicode())
2277
class TestBackupNames(tests.TestCase):
2280
super(TestBackupNames, self).setUp()
2283
def backup_exists(self, name):
2284
return name in self.backups
2286
def available_backup_name(self, name):
2287
backup_name = osutils.available_backup_name(name, self.backup_exists)
2288
self.backups.append(backup_name)
2291
def assertBackupName(self, expected, name):
2292
self.assertEqual(expected, self.available_backup_name(name))
2294
def test_empty(self):
2295
self.assertBackupName('file.~1~', 'file')
2297
def test_existing(self):
2298
self.available_backup_name('file')
2299
self.available_backup_name('file')
2300
self.assertBackupName('file.~3~', 'file')
2301
# Empty slots are found, this is not a strict requirement and may be
2302
# revisited if we test against all implementations.
2303
self.backups.remove('file.~2~')
2304
self.assertBackupName('file.~2~', 'file')
2307
class TestFindExecutableInPath(tests.TestCase):
2309
def test_windows(self):
2310
if sys.platform != 'win32':
2311
raise tests.TestSkipped('test requires win32')
2312
self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
2314
osutils.find_executable_on_path('explorer.exe') is not None)
2316
osutils.find_executable_on_path('EXPLORER.EXE') is not None)
2318
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2319
self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
2321
def test_windows_app_path(self):
2322
if sys.platform != 'win32':
2323
raise tests.TestSkipped('test requires win32')
2324
# Override PATH env var so that exe can only be found on App Path
2325
self.overrideEnv('PATH', '')
2326
# Internt Explorer is always registered in the App Path
2327
self.assertTrue(osutils.find_executable_on_path('iexplore') is not None)
2329
def test_other(self):
2330
if sys.platform == 'win32':
2331
raise tests.TestSkipped('test requires non-win32')
2332
self.assertTrue(osutils.find_executable_on_path('sh') is not None)
2334
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2337
class TestEnvironmentErrors(tests.TestCase):
2338
"""Test handling of environmental errors"""
2340
def test_is_oserror(self):
2341
self.assertTrue(osutils.is_environment_error(
2342
OSError(errno.EINVAL, "Invalid parameter")))
2344
def test_is_ioerror(self):
2345
self.assertTrue(osutils.is_environment_error(
2346
IOError(errno.EINVAL, "Invalid parameter")))
2348
def test_is_socket_error(self):
2349
self.assertTrue(osutils.is_environment_error(
2350
socket.error(errno.EINVAL, "Invalid parameter")))
2352
def test_is_select_error(self):
2353
self.assertTrue(osutils.is_environment_error(
2354
select.error(errno.EINVAL, "Invalid parameter")))
2356
def test_is_pywintypes_error(self):
2357
self.requireFeature(features.pywintypes)
2359
self.assertTrue(osutils.is_environment_error(
2360
pywintypes.error(errno.EINVAL, "Invalid parameter", "Caller")))
added
removed
bzrlib/tests/test_osutils.py
