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
17
17
"""Tests for the osutils wrapper."""
19
from cStringIO import StringIO
26
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
27
import bzrlib.osutils as osutils
37
28
from bzrlib.tests import (
44
class _UTF8DirReaderFeature(tests.Feature):
48
from bzrlib import _readdir_pyx
49
self.reader = _readdir_pyx.UTF8DirReader
54
def feature_name(self):
55
return 'bzrlib._readdir_pyx'
57
UTF8DirReaderFeature = _UTF8DirReaderFeature()
59
term_ios_feature = tests.ModuleAvailableFeature('termios')
62
def _already_unicode(s):
66
def _utf8_to_unicode(s):
67
return s.decode('UTF-8')
70
def dir_reader_scenarios():
71
# For each dir reader we define:
73
# - native_to_unicode: a function converting the native_abspath as returned
74
# by DirReader.read_dir to its unicode representation
76
# UnicodeDirReader is the fallback, it should be tested on all platforms.
77
scenarios = [('unicode',
78
dict(_dir_reader_class=osutils.UnicodeDirReader,
79
_native_to_unicode=_already_unicode))]
80
# Some DirReaders are platform specific and even there they may not be
82
if UTF8DirReaderFeature.available():
83
from bzrlib import _readdir_pyx
84
scenarios.append(('utf8',
85
dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
86
_native_to_unicode=_utf8_to_unicode)))
88
if test__walkdirs_win32.win32_readdir_feature.available():
90
from bzrlib import _walkdirs_win32
93
dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
94
_native_to_unicode=_already_unicode)))
100
def load_tests(basic_tests, module, loader):
101
suite = loader.suiteClass()
102
dir_reader_tests, remaining_tests = tests.split_suite_by_condition(
103
basic_tests, tests.condition_isinstance(TestDirReader))
104
tests.multiply_tests(dir_reader_tests, dir_reader_scenarios(), suite)
105
suite.addTest(remaining_tests)
109
class TestContainsWhitespace(tests.TestCase):
111
def test_contains_whitespace(self):
112
self.failUnless(osutils.contains_whitespace(u' '))
113
self.failUnless(osutils.contains_whitespace(u'hello there'))
114
self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
115
self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
116
self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
117
self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
119
# \xa0 is "Non-breaking-space" which on some python locales thinks it
120
# is whitespace, but we do not.
121
self.failIf(osutils.contains_whitespace(u''))
122
self.failIf(osutils.contains_whitespace(u'hellothere'))
123
self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
126
class TestRename(tests.TestCaseInTempDir):
128
def create_file(self, filename, content):
129
f = open(filename, 'wb')
135
def _fancy_rename(self, a, b):
136
osutils.fancy_rename(a, b, rename_func=os.rename,
137
unlink_func=os.unlink)
36
class TestOSUtils(TestCaseInTempDir):
139
38
def test_fancy_rename(self):
140
39
# This should work everywhere
141
self.create_file('a', 'something in a\n')
142
self._fancy_rename('a', 'b')
41
osutils.fancy_rename(a, b,
42
rename_func=os.rename,
43
unlink_func=os.unlink)
45
open('a', 'wb').write('something in a\n')
143
47
self.failIfExists('a')
144
48
self.failUnlessExists('b')
145
49
self.check_file_contents('b', 'something in a\n')
147
self.create_file('a', 'new something in a\n')
148
self._fancy_rename('b', 'a')
51
open('a', 'wb').write('new something in a\n')
150
54
self.check_file_contents('a', 'something in a\n')
152
def test_fancy_rename_fails_source_missing(self):
153
# An exception should be raised, and the target should be left in place
154
self.create_file('target', 'data in target\n')
155
self.assertRaises((IOError, OSError), self._fancy_rename,
156
'missingsource', 'target')
157
self.failUnlessExists('target')
158
self.check_file_contents('target', 'data in target\n')
160
def test_fancy_rename_fails_if_source_and_target_missing(self):
161
self.assertRaises((IOError, OSError), self._fancy_rename,
162
'missingsource', 'missingtarget')
164
56
def test_rename(self):
165
57
# Rename should be semi-atomic on all platforms
166
self.create_file('a', 'something in a\n')
58
open('a', 'wb').write('something in a\n')
167
59
osutils.rename('a', 'b')
168
60
self.failIfExists('a')
169
61
self.failUnlessExists('b')
170
62
self.check_file_contents('b', 'something in a\n')
172
self.create_file('a', 'new something in a\n')
64
open('a', 'wb').write('new something in a\n')
173
65
osutils.rename('b', 'a')
175
67
self.check_file_contents('a', 'something in a\n')
177
69
# TODO: test fancy_rename using a MemoryTransport
179
def test_rename_change_case(self):
180
# on Windows we should be able to change filename case by rename
181
self.build_tree(['a', 'b/'])
182
osutils.rename('a', 'A')
183
osutils.rename('b', 'B')
184
# we can't use failUnlessExists on case-insensitive filesystem
185
# so try to check shape of the tree
186
shape = sorted(os.listdir('.'))
187
self.assertEquals(['A', 'B'], shape)
190
class TestRandChars(tests.TestCase):
192
71
def test_01_rand_chars_empty(self):
193
72
result = osutils.rand_chars(0)
194
73
self.assertEqual(result, '')
307
132
os.remove('socket')
309
def test_kind_marker(self):
310
self.assertEqual("", osutils.kind_marker("file"))
311
self.assertEqual("/", osutils.kind_marker('directory'))
312
self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
313
self.assertEqual("@", osutils.kind_marker("symlink"))
314
self.assertEqual("+", osutils.kind_marker("tree-reference"))
315
self.assertEqual("", osutils.kind_marker("fifo"))
316
self.assertEqual("", osutils.kind_marker("socket"))
317
self.assertEqual("", osutils.kind_marker("unknown"))
320
class TestUmask(tests.TestCaseInTempDir):
322
def test_get_umask(self):
323
if sys.platform == 'win32':
324
# umask always returns '0', no way to set it
325
self.assertEqual(0, osutils.get_umask())
328
orig_umask = osutils.get_umask()
329
self.addCleanup(os.umask, orig_umask)
331
self.assertEqual(0222, osutils.get_umask())
333
self.assertEqual(0022, osutils.get_umask())
335
self.assertEqual(0002, osutils.get_umask())
337
self.assertEqual(0027, osutils.get_umask())
340
class TestDateTime(tests.TestCase):
342
def assertFormatedDelta(self, expected, seconds):
343
"""Assert osutils.format_delta formats as expected"""
344
actual = osutils.format_delta(seconds)
345
self.assertEqual(expected, actual)
347
def test_format_delta(self):
348
self.assertFormatedDelta('0 seconds ago', 0)
349
self.assertFormatedDelta('1 second ago', 1)
350
self.assertFormatedDelta('10 seconds ago', 10)
351
self.assertFormatedDelta('59 seconds ago', 59)
352
self.assertFormatedDelta('89 seconds ago', 89)
353
self.assertFormatedDelta('1 minute, 30 seconds ago', 90)
354
self.assertFormatedDelta('3 minutes, 0 seconds ago', 180)
355
self.assertFormatedDelta('3 minutes, 1 second ago', 181)
356
self.assertFormatedDelta('10 minutes, 15 seconds ago', 615)
357
self.assertFormatedDelta('30 minutes, 59 seconds ago', 1859)
358
self.assertFormatedDelta('31 minutes, 0 seconds ago', 1860)
359
self.assertFormatedDelta('60 minutes, 0 seconds ago', 3600)
360
self.assertFormatedDelta('89 minutes, 59 seconds ago', 5399)
361
self.assertFormatedDelta('1 hour, 30 minutes ago', 5400)
362
self.assertFormatedDelta('2 hours, 30 minutes ago', 9017)
363
self.assertFormatedDelta('10 hours, 0 minutes ago', 36000)
364
self.assertFormatedDelta('24 hours, 0 minutes ago', 86400)
365
self.assertFormatedDelta('35 hours, 59 minutes ago', 129599)
366
self.assertFormatedDelta('36 hours, 0 minutes ago', 129600)
367
self.assertFormatedDelta('36 hours, 0 minutes ago', 129601)
368
self.assertFormatedDelta('36 hours, 1 minute ago', 129660)
369
self.assertFormatedDelta('36 hours, 1 minute ago', 129661)
370
self.assertFormatedDelta('84 hours, 10 minutes ago', 303002)
372
# We handle when time steps the wrong direction because computers
373
# don't have synchronized clocks.
374
self.assertFormatedDelta('84 hours, 10 minutes in the future', -303002)
375
self.assertFormatedDelta('1 second in the future', -1)
376
self.assertFormatedDelta('2 seconds in the future', -2)
378
def test_format_date(self):
379
self.assertRaises(errors.UnsupportedTimezoneFormat,
380
osutils.format_date, 0, timezone='foo')
381
self.assertIsInstance(osutils.format_date(0), str)
382
self.assertIsInstance(osutils.format_local_date(0), unicode)
383
# Testing for the actual value of the local weekday without
384
# duplicating the code from format_date is difficult.
385
# Instead blackbox.test_locale should check for localized
386
# dates once they do occur in output strings.
388
def test_format_date_with_offset_in_original_timezone(self):
389
self.assertEqual("Thu 1970-01-01 00:00:00 +0000",
390
osutils.format_date_with_offset_in_original_timezone(0))
391
self.assertEqual("Fri 1970-01-02 03:46:40 +0000",
392
osutils.format_date_with_offset_in_original_timezone(100000))
393
self.assertEqual("Fri 1970-01-02 05:46:40 +0200",
394
osutils.format_date_with_offset_in_original_timezone(100000, 7200))
396
def test_local_time_offset(self):
397
"""Test that local_time_offset() returns a sane value."""
398
offset = osutils.local_time_offset()
399
self.assertTrue(isinstance(offset, int))
400
# Test that the offset is no more than a eighteen hours in
402
# Time zone handling is system specific, so it is difficult to
403
# do more specific tests, but a value outside of this range is
405
eighteen_hours = 18 * 3600
406
self.assertTrue(-eighteen_hours < offset < eighteen_hours)
408
def test_local_time_offset_with_timestamp(self):
409
"""Test that local_time_offset() works with a timestamp."""
410
offset = osutils.local_time_offset(1000000000.1234567)
411
self.assertTrue(isinstance(offset, int))
412
eighteen_hours = 18 * 3600
413
self.assertTrue(-eighteen_hours < offset < eighteen_hours)
416
class TestLinks(tests.TestCaseInTempDir):
418
def test_dereference_path(self):
419
self.requireFeature(tests.SymlinkFeature)
420
cwd = osutils.realpath('.')
422
bar_path = osutils.pathjoin(cwd, 'bar')
423
# Using './' to avoid bug #1213894 (first path component not
424
# dereferenced) in Python 2.4.1 and earlier
425
self.assertEqual(bar_path, osutils.realpath('./bar'))
426
os.symlink('bar', 'foo')
427
self.assertEqual(bar_path, osutils.realpath('./foo'))
429
# Does not dereference terminal symlinks
430
foo_path = osutils.pathjoin(cwd, 'foo')
431
self.assertEqual(foo_path, osutils.dereference_path('./foo'))
433
# Dereferences parent symlinks
435
baz_path = osutils.pathjoin(bar_path, 'baz')
436
self.assertEqual(baz_path, osutils.dereference_path('./foo/baz'))
438
# Dereferences parent symlinks that are the first path element
439
self.assertEqual(baz_path, osutils.dereference_path('foo/baz'))
441
# Dereferences parent symlinks in absolute paths
442
foo_baz_path = osutils.pathjoin(foo_path, 'baz')
443
self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
445
def test_changing_access(self):
446
f = file('file', 'w')
450
# Make a file readonly
451
osutils.make_readonly('file')
452
mode = os.lstat('file').st_mode
453
self.assertEqual(mode, mode & 0777555)
455
# Make a file writable
456
osutils.make_writable('file')
457
mode = os.lstat('file').st_mode
458
self.assertEqual(mode, mode | 0200)
460
if osutils.has_symlinks():
461
# should not error when handed a symlink
462
os.symlink('nonexistent', 'dangling')
463
osutils.make_readonly('dangling')
464
osutils.make_writable('dangling')
466
def test_host_os_dereferences_symlinks(self):
467
osutils.host_os_dereferences_symlinks()
470
class TestCanonicalRelPath(tests.TestCaseInTempDir):
472
_test_needs_features = [tests.CaseInsCasePresFilenameFeature]
474
def test_canonical_relpath_simple(self):
475
f = file('MixedCaseName', 'w')
477
actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
478
self.failUnlessEqual('work/MixedCaseName', actual)
480
def test_canonical_relpath_missing_tail(self):
481
os.mkdir('MixedCaseParent')
482
actual = osutils.canonical_relpath(self.test_base_dir,
483
'mixedcaseparent/nochild')
484
self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
487
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
489
def assertRelpath(self, expected, base, path):
490
actual = osutils._cicp_canonical_relpath(base, path)
491
self.assertEqual(expected, actual)
493
def test_simple(self):
494
self.build_tree(['MixedCaseName'])
495
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
496
self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
498
def test_subdir_missing_tail(self):
499
self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
500
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
501
self.assertRelpath('MixedCaseParent/a_child', base,
502
'MixedCaseParent/a_child')
503
self.assertRelpath('MixedCaseParent/a_child', base,
504
'MixedCaseParent/A_Child')
505
self.assertRelpath('MixedCaseParent/not_child', base,
506
'MixedCaseParent/not_child')
508
def test_at_root_slash(self):
509
# We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
511
if osutils.MIN_ABS_PATHLENGTH > 1:
512
raise tests.TestSkipped('relpath requires %d chars'
513
% osutils.MIN_ABS_PATHLENGTH)
514
self.assertRelpath('foo', '/', '/foo')
516
def test_at_root_drive(self):
517
if sys.platform != 'win32':
518
raise tests.TestNotApplicable('we can only test drive-letter relative'
519
' paths on Windows where we have drive'
522
# The specific issue is that when at the root of a drive, 'abspath'
523
# returns "C:/" or just "/". However, the code assumes that abspath
524
# always returns something like "C:/foo" or "/foo" (no trailing slash).
525
self.assertRelpath('foo', 'C:/', 'C:/foo')
526
self.assertRelpath('foo', 'X:/', 'X:/foo')
527
self.assertRelpath('foo', 'X:/', 'X://foo')
530
class TestPumpFile(tests.TestCase):
531
"""Test pumpfile method."""
534
tests.TestCase.setUp(self)
535
# create a test datablock
536
self.block_size = 512
537
pattern = '0123456789ABCDEF'
538
self.test_data = pattern * (3 * self.block_size / len(pattern))
539
self.test_data_len = len(self.test_data)
541
def test_bracket_block_size(self):
542
"""Read data in blocks with the requested read size bracketing the
544
# make sure test data is larger than max read size
545
self.assertTrue(self.test_data_len > self.block_size)
547
from_file = file_utils.FakeReadFile(self.test_data)
550
# read (max / 2) bytes and verify read size wasn't affected
551
num_bytes_to_read = self.block_size / 2
552
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
553
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
554
self.assertEqual(from_file.get_read_count(), 1)
556
# read (max) bytes and verify read size wasn't affected
557
num_bytes_to_read = self.block_size
558
from_file.reset_read_count()
559
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
560
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
561
self.assertEqual(from_file.get_read_count(), 1)
563
# read (max + 1) bytes and verify read size was limited
564
num_bytes_to_read = self.block_size + 1
565
from_file.reset_read_count()
566
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
567
self.assertEqual(from_file.get_max_read_size(), self.block_size)
568
self.assertEqual(from_file.get_read_count(), 2)
570
# finish reading the rest of the data
571
num_bytes_to_read = self.test_data_len - to_file.tell()
572
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
574
# report error if the data wasn't equal (we only report the size due
575
# to the length of the data)
576
response_data = to_file.getvalue()
577
if response_data != self.test_data:
578
message = "Data not equal. Expected %d bytes, received %d."
579
self.fail(message % (len(response_data), self.test_data_len))
581
def test_specified_size(self):
582
"""Request a transfer larger than the maximum block size and verify
583
that the maximum read doesn't exceed the block_size."""
584
# make sure test data is larger than max read size
585
self.assertTrue(self.test_data_len > self.block_size)
587
# retrieve data in blocks
588
from_file = file_utils.FakeReadFile(self.test_data)
590
osutils.pumpfile(from_file, to_file, self.test_data_len,
593
# verify read size was equal to the maximum read size
594
self.assertTrue(from_file.get_max_read_size() > 0)
595
self.assertEqual(from_file.get_max_read_size(), self.block_size)
596
self.assertEqual(from_file.get_read_count(), 3)
598
# report error if the data wasn't equal (we only report the size due
599
# to the length of the data)
600
response_data = to_file.getvalue()
601
if response_data != self.test_data:
602
message = "Data not equal. Expected %d bytes, received %d."
603
self.fail(message % (len(response_data), self.test_data_len))
605
def test_to_eof(self):
606
"""Read to end-of-file and verify that the reads are not larger than
607
the maximum read size."""
608
# make sure test data is larger than max read size
609
self.assertTrue(self.test_data_len > self.block_size)
611
# retrieve data to EOF
612
from_file = file_utils.FakeReadFile(self.test_data)
614
osutils.pumpfile(from_file, to_file, -1, self.block_size)
616
# verify read size was equal to the maximum read size
617
self.assertEqual(from_file.get_max_read_size(), self.block_size)
618
self.assertEqual(from_file.get_read_count(), 4)
620
# report error if the data wasn't equal (we only report the size due
621
# to the length of the data)
622
response_data = to_file.getvalue()
623
if response_data != self.test_data:
624
message = "Data not equal. Expected %d bytes, received %d."
625
self.fail(message % (len(response_data), self.test_data_len))
627
def test_defaults(self):
628
"""Verifies that the default arguments will read to EOF -- this
629
test verifies that any existing usages of pumpfile will not be broken
630
with this new version."""
631
# retrieve data using default (old) pumpfile method
632
from_file = file_utils.FakeReadFile(self.test_data)
634
osutils.pumpfile(from_file, to_file)
636
# report error if the data wasn't equal (we only report the size due
637
# to the length of the data)
638
response_data = to_file.getvalue()
639
if response_data != self.test_data:
640
message = "Data not equal. Expected %d bytes, received %d."
641
self.fail(message % (len(response_data), self.test_data_len))
643
def test_report_activity(self):
645
def log_activity(length, direction):
646
activity.append((length, direction))
647
from_file = StringIO(self.test_data)
649
osutils.pumpfile(from_file, to_file, buff_size=500,
650
report_activity=log_activity, direction='read')
651
self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
652
(36, 'read')], activity)
654
from_file = StringIO(self.test_data)
657
osutils.pumpfile(from_file, to_file, buff_size=500,
658
report_activity=log_activity, direction='write')
659
self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
660
(36, 'write')], activity)
662
# And with a limited amount of data
663
from_file = StringIO(self.test_data)
666
osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
667
report_activity=log_activity, direction='read')
668
self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
672
class TestPumpStringFile(tests.TestCase):
674
def test_empty(self):
676
osutils.pump_string_file("", output)
677
self.assertEqual("", output.getvalue())
679
def test_more_than_segment_size(self):
681
osutils.pump_string_file("123456789", output, 2)
682
self.assertEqual("123456789", output.getvalue())
684
def test_segment_size(self):
686
osutils.pump_string_file("12", output, 2)
687
self.assertEqual("12", output.getvalue())
689
def test_segment_size_multiple(self):
691
osutils.pump_string_file("1234", output, 2)
692
self.assertEqual("1234", output.getvalue())
695
class TestRelpath(tests.TestCase):
697
def test_simple_relpath(self):
698
cwd = osutils.getcwd()
699
subdir = cwd + '/subdir'
700
self.assertEqual('subdir', osutils.relpath(cwd, subdir))
702
def test_deep_relpath(self):
703
cwd = osutils.getcwd()
704
subdir = cwd + '/sub/subsubdir'
705
self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
707
def test_not_relative(self):
708
self.assertRaises(errors.PathNotChild,
709
osutils.relpath, 'C:/path', 'H:/path')
710
self.assertRaises(errors.PathNotChild,
711
osutils.relpath, 'C:/', 'H:/path')
714
class TestSafeUnicode(tests.TestCase):
135
class TestSafeUnicode(TestCase):
716
137
def test_from_ascii_string(self):
717
138
self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
726
147
self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
728
149
def test_bad_utf8_string(self):
729
self.assertRaises(errors.BzrBadParameterNotUnicode,
150
self.assertRaises(BzrBadParameterNotUnicode,
730
151
osutils.safe_unicode,
734
class TestSafeUtf8(tests.TestCase):
736
def test_from_ascii_string(self):
738
self.assertEqual('foobar', osutils.safe_utf8(f))
740
def test_from_unicode_string_ascii_contents(self):
741
self.assertEqual('bargam', osutils.safe_utf8(u'bargam'))
743
def test_from_unicode_string_unicode_contents(self):
744
self.assertEqual('bargam\xc2\xae', osutils.safe_utf8(u'bargam\xae'))
746
def test_from_utf8_string(self):
747
self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
749
def test_bad_utf8_string(self):
750
self.assertRaises(errors.BzrBadParameterNotUnicode,
751
osutils.safe_utf8, '\xbb\xbb')
754
class TestSafeRevisionId(tests.TestCase):
756
def test_from_ascii_string(self):
757
# this shouldn't give a warning because it's getting an ascii string
758
self.assertEqual('foobar', osutils.safe_revision_id('foobar'))
760
def test_from_unicode_string_ascii_contents(self):
761
self.assertEqual('bargam',
762
osutils.safe_revision_id(u'bargam', warn=False))
764
def test_from_unicode_deprecated(self):
765
self.assertEqual('bargam',
766
self.callDeprecated([osutils._revision_id_warning],
767
osutils.safe_revision_id, u'bargam'))
769
def test_from_unicode_string_unicode_contents(self):
770
self.assertEqual('bargam\xc2\xae',
771
osutils.safe_revision_id(u'bargam\xae', warn=False))
773
def test_from_utf8_string(self):
774
self.assertEqual('foo\xc2\xae',
775
osutils.safe_revision_id('foo\xc2\xae'))
778
"""Currently, None is a valid revision_id"""
779
self.assertEqual(None, osutils.safe_revision_id(None))
782
class TestSafeFileId(tests.TestCase):
784
def test_from_ascii_string(self):
785
self.assertEqual('foobar', osutils.safe_file_id('foobar'))
787
def test_from_unicode_string_ascii_contents(self):
788
self.assertEqual('bargam', osutils.safe_file_id(u'bargam', warn=False))
790
def test_from_unicode_deprecated(self):
791
self.assertEqual('bargam',
792
self.callDeprecated([osutils._file_id_warning],
793
osutils.safe_file_id, u'bargam'))
795
def test_from_unicode_string_unicode_contents(self):
796
self.assertEqual('bargam\xc2\xae',
797
osutils.safe_file_id(u'bargam\xae', warn=False))
799
def test_from_utf8_string(self):
800
self.assertEqual('foo\xc2\xae',
801
osutils.safe_file_id('foo\xc2\xae'))
804
"""Currently, None is a valid revision_id"""
805
self.assertEqual(None, osutils.safe_file_id(None))
808
class TestWin32Funcs(tests.TestCase):
809
"""Test that _win32 versions of os utilities return appropriate paths."""
155
class TestWin32Funcs(TestCase):
156
"""Test that the _win32 versions of os utilities return appropriate paths."""
811
158
def test_abspath(self):
812
159
self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
813
160
self.assertEqual('C:/foo', osutils._win32_abspath('C:/foo'))
814
self.assertEqual('//HOST/path', osutils._win32_abspath(r'\\HOST\path'))
815
self.assertEqual('//HOST/path', osutils._win32_abspath('//HOST/path'))
817
162
def test_realpath(self):
818
163
self.assertEqual('C:/foo', osutils._win32_realpath('C:\\foo'))
819
164
self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
821
166
def test_pathjoin(self):
822
self.assertEqual('path/to/foo',
823
osutils._win32_pathjoin('path', 'to', 'foo'))
824
self.assertEqual('C:/foo',
825
osutils._win32_pathjoin('path\\to', 'C:\\foo'))
826
self.assertEqual('C:/foo',
827
osutils._win32_pathjoin('path/to', 'C:/foo'))
828
self.assertEqual('path/to/foo',
829
osutils._win32_pathjoin('path/to/', 'foo'))
830
self.assertEqual('/foo',
831
osutils._win32_pathjoin('C:/path/to/', '/foo'))
832
self.assertEqual('/foo',
833
osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
167
self.assertEqual('path/to/foo', osutils._win32_pathjoin('path', 'to', 'foo'))
168
self.assertEqual('C:/foo', osutils._win32_pathjoin('path\\to', 'C:\\foo'))
169
self.assertEqual('C:/foo', osutils._win32_pathjoin('path/to', 'C:/foo'))
170
self.assertEqual('path/to/foo', osutils._win32_pathjoin('path/to/', 'foo'))
171
self.assertEqual('/foo', osutils._win32_pathjoin('C:/path/to/', '/foo'))
172
self.assertEqual('/foo', osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
835
174
def test_normpath(self):
836
self.assertEqual('path/to/foo',
837
osutils._win32_normpath(r'path\\from\..\to\.\foo'))
838
self.assertEqual('path/to/foo',
839
osutils._win32_normpath('path//from/../to/./foo'))
175
self.assertEqual('path/to/foo', osutils._win32_normpath(r'path\\from\..\to\.\foo'))
176
self.assertEqual('path/to/foo', osutils._win32_normpath('path//from/../to/./foo'))
841
178
def test_getcwd(self):
842
179
cwd = osutils._win32_getcwd()
1033
308
self.build_tree(tree)
1034
309
expected_dirblocks = [
1036
[('0file', '0file', 'file'),
1037
('1dir', '1dir', 'directory'),
1038
('2file', '2file', 'file'),
1041
(('1dir', './1dir'),
1042
[('1dir/0file', '0file', 'file'),
1043
('1dir/1dir', '1dir', 'directory'),
1046
(('1dir/1dir', './1dir/1dir'),
1052
found_bzrdir = False
1053
for dirdetail, dirblock in osutils.walkdirs('.'):
1054
if len(dirblock) and dirblock[0][1] == '.bzr':
1055
# this tests the filtering of selected paths
1058
result.append((dirdetail, dirblock))
1060
self.assertTrue(found_bzrdir)
1061
self.assertExpectedBlocks(expected_dirblocks, result)
1062
# you can search a subdir only, with a supplied prefix.
1064
for dirblock in osutils.walkdirs('./1dir', '1dir'):
1065
result.append(dirblock)
1066
self.assertExpectedBlocks(expected_dirblocks[1:], result)
1068
def test_walkdirs_os_error(self):
1069
# <https://bugs.launchpad.net/bzr/+bug/338653>
1070
# Pyrex readdir didn't raise useful messages if it had an error
1071
# reading the directory
1072
if sys.platform == 'win32':
1073
raise tests.TestNotApplicable(
1074
"readdir IOError not tested on win32")
1075
os.mkdir("test-unreadable")
1076
os.chmod("test-unreadable", 0000)
1077
# must chmod it back so that it can be removed
1078
self.addCleanup(os.chmod, "test-unreadable", 0700)
1079
# The error is not raised until the generator is actually evaluated.
1080
# (It would be ok if it happened earlier but at the moment it
1082
e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
1083
self.assertEquals('./test-unreadable', e.filename)
1084
self.assertEquals(errno.EACCES, e.errno)
1085
# Ensure the message contains the file name
1086
self.assertContainsRe(str(e), "\./test-unreadable")
1089
def test_walkdirs_encoding_error(self):
1090
# <https://bugs.launchpad.net/bzr/+bug/488519>
1091
# walkdirs didn't raise a useful message when the filenames
1092
# are not using the filesystem's encoding
1094
# require a bytestring based filesystem
1095
self.requireFeature(tests.ByteStringNamedFilesystem)
1106
self.build_tree(tree)
1108
# rename the 1file to a latin-1 filename
1109
os.rename("./1file", "\xe8file")
1111
self._save_platform_info()
1112
win32utils.winver = None # Avoid the win32 detection code
1113
osutils._fs_enc = 'UTF-8'
1115
# this should raise on error
1117
for dirdetail, dirblock in osutils.walkdirs('.'):
1120
self.assertRaises(errors.BadFilenameEncoding, attempt)
1122
def test__walkdirs_utf8(self):
1131
self.build_tree(tree)
1132
expected_dirblocks = [
1134
[('0file', '0file', 'file'),
1135
('1dir', '1dir', 'directory'),
1136
('2file', '2file', 'file'),
1139
(('1dir', './1dir'),
1140
[('1dir/0file', '0file', 'file'),
1141
('1dir/1dir', '1dir', 'directory'),
1144
(('1dir/1dir', './1dir/1dir'),
1150
found_bzrdir = False
1151
for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
1152
if len(dirblock) and dirblock[0][1] == '.bzr':
1153
# this tests the filtering of selected paths
1156
result.append((dirdetail, dirblock))
1158
self.assertTrue(found_bzrdir)
1159
self.assertExpectedBlocks(expected_dirblocks, result)
1161
# you can search a subdir only, with a supplied prefix.
1163
for dirblock in osutils.walkdirs('./1dir', '1dir'):
1164
result.append(dirblock)
1165
self.assertExpectedBlocks(expected_dirblocks[1:], result)
1167
def _filter_out_stat(self, result):
1168
"""Filter out the stat value from the walkdirs result"""
1169
for dirdetail, dirblock in result:
1171
for info in dirblock:
1172
# Ignore info[3] which is the stat
1173
new_dirblock.append((info[0], info[1], info[2], info[4]))
1174
dirblock[:] = new_dirblock
1176
def _save_platform_info(self):
1177
self.overrideAttr(win32utils, 'winver')
1178
self.overrideAttr(osutils, '_fs_enc')
1179
self.overrideAttr(osutils, '_selected_dir_reader')
1181
def assertDirReaderIs(self, expected):
1182
"""Assert the right implementation for _walkdirs_utf8 is chosen."""
1183
# Force it to redetect
1184
osutils._selected_dir_reader = None
1185
# Nothing to list, but should still trigger the selection logic
1186
self.assertEqual([(('', '.'), [])], list(osutils._walkdirs_utf8('.')))
1187
self.assertIsInstance(osutils._selected_dir_reader, expected)
1189
def test_force_walkdirs_utf8_fs_utf8(self):
1190
self.requireFeature(UTF8DirReaderFeature)
1191
self._save_platform_info()
1192
win32utils.winver = None # Avoid the win32 detection code
1193
osutils._fs_enc = 'UTF-8'
1194
self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1196
def test_force_walkdirs_utf8_fs_ascii(self):
1197
self.requireFeature(UTF8DirReaderFeature)
1198
self._save_platform_info()
1199
win32utils.winver = None # Avoid the win32 detection code
1200
osutils._fs_enc = 'US-ASCII'
1201
self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1203
def test_force_walkdirs_utf8_fs_ANSI(self):
1204
self.requireFeature(UTF8DirReaderFeature)
1205
self._save_platform_info()
1206
win32utils.winver = None # Avoid the win32 detection code
1207
osutils._fs_enc = 'ANSI_X3.4-1968'
1208
self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1210
def test_force_walkdirs_utf8_fs_latin1(self):
1211
self._save_platform_info()
1212
win32utils.winver = None # Avoid the win32 detection code
1213
osutils._fs_enc = 'latin1'
1214
self.assertDirReaderIs(osutils.UnicodeDirReader)
1216
def test_force_walkdirs_utf8_nt(self):
1217
# Disabled because the thunk of the whole walkdirs api is disabled.
1218
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1219
self._save_platform_info()
1220
win32utils.winver = 'Windows NT'
1221
from bzrlib._walkdirs_win32 import Win32ReadDir
1222
self.assertDirReaderIs(Win32ReadDir)
1224
def test_force_walkdirs_utf8_98(self):
1225
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1226
self._save_platform_info()
1227
win32utils.winver = 'Windows 98'
1228
self.assertDirReaderIs(osutils.UnicodeDirReader)
1230
def test_unicode_walkdirs(self):
1231
"""Walkdirs should always return unicode paths."""
1232
self.requireFeature(tests.UnicodeFilenameFeature)
1233
name0 = u'0file-\xb6'
1234
name1 = u'1dir-\u062c\u0648'
1235
name2 = u'2file-\u0633'
1239
name1 + '/' + name0,
1240
name1 + '/' + name1 + '/',
1243
self.build_tree(tree)
1244
expected_dirblocks = [
1246
[(name0, name0, 'file', './' + name0),
1247
(name1, name1, 'directory', './' + name1),
1248
(name2, name2, 'file', './' + name2),
1251
((name1, './' + name1),
1252
[(name1 + '/' + name0, name0, 'file', './' + name1
1254
(name1 + '/' + name1, name1, 'directory', './' + name1
1258
((name1 + '/' + name1, './' + name1 + '/' + name1),
1263
result = list(osutils.walkdirs('.'))
1264
self._filter_out_stat(result)
1265
self.assertEqual(expected_dirblocks, result)
1266
result = list(osutils.walkdirs(u'./'+name1, name1))
1267
self._filter_out_stat(result)
1268
self.assertEqual(expected_dirblocks[1:], result)
1270
def test_unicode__walkdirs_utf8(self):
1271
"""Walkdirs_utf8 should always return utf8 paths.
1273
The abspath portion might be in unicode or utf-8
1275
self.requireFeature(tests.UnicodeFilenameFeature)
1276
name0 = u'0file-\xb6'
1277
name1 = u'1dir-\u062c\u0648'
1278
name2 = u'2file-\u0633'
1282
name1 + '/' + name0,
1283
name1 + '/' + name1 + '/',
1286
self.build_tree(tree)
1287
name0 = name0.encode('utf8')
1288
name1 = name1.encode('utf8')
1289
name2 = name2.encode('utf8')
1291
expected_dirblocks = [
1293
[(name0, name0, 'file', './' + name0),
1294
(name1, name1, 'directory', './' + name1),
1295
(name2, name2, 'file', './' + name2),
1298
((name1, './' + name1),
1299
[(name1 + '/' + name0, name0, 'file', './' + name1
1301
(name1 + '/' + name1, name1, 'directory', './' + name1
1305
((name1 + '/' + name1, './' + name1 + '/' + name1),
1311
# For ease in testing, if walkdirs_utf8 returns Unicode, assert that
1312
# all abspaths are Unicode, and encode them back into utf8.
1313
for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
1314
self.assertIsInstance(dirdetail[0], str)
1315
if isinstance(dirdetail[1], unicode):
1316
dirdetail = (dirdetail[0], dirdetail[1].encode('utf8'))
1317
dirblock = [list(info) for info in dirblock]
1318
for info in dirblock:
1319
self.assertIsInstance(info[4], unicode)
1320
info[4] = info[4].encode('utf8')
1322
for info in dirblock:
1323
self.assertIsInstance(info[0], str)
1324
self.assertIsInstance(info[1], str)
1325
self.assertIsInstance(info[4], str)
1326
# Remove the stat information
1327
new_dirblock.append((info[0], info[1], info[2], info[4]))
1328
result.append((dirdetail, new_dirblock))
1329
self.assertEqual(expected_dirblocks, result)
1331
def test__walkdirs_utf8_with_unicode_fs(self):
1332
"""UnicodeDirReader should be a safe fallback everywhere
1334
The abspath portion should be in unicode
1336
self.requireFeature(tests.UnicodeFilenameFeature)
1337
# Use the unicode reader. TODO: split into driver-and-driven unit
1339
self._save_platform_info()
1340
osutils._selected_dir_reader = osutils.UnicodeDirReader()
1341
name0u = u'0file-\xb6'
1342
name1u = u'1dir-\u062c\u0648'
1343
name2u = u'2file-\u0633'
1347
name1u + '/' + name0u,
1348
name1u + '/' + name1u + '/',
1351
self.build_tree(tree)
1352
name0 = name0u.encode('utf8')
1353
name1 = name1u.encode('utf8')
1354
name2 = name2u.encode('utf8')
1356
# All of the abspaths should be in unicode, all of the relative paths
1358
expected_dirblocks = [
1360
[(name0, name0, 'file', './' + name0u),
1361
(name1, name1, 'directory', './' + name1u),
1362
(name2, name2, 'file', './' + name2u),
1365
((name1, './' + name1u),
1366
[(name1 + '/' + name0, name0, 'file', './' + name1u
1368
(name1 + '/' + name1, name1, 'directory', './' + name1u
1372
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1377
result = list(osutils._walkdirs_utf8('.'))
1378
self._filter_out_stat(result)
1379
self.assertEqual(expected_dirblocks, result)
1381
def test__walkdirs_utf8_win32readdir(self):
1382
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1383
self.requireFeature(tests.UnicodeFilenameFeature)
1384
from bzrlib._walkdirs_win32 import Win32ReadDir
1385
self._save_platform_info()
1386
osutils._selected_dir_reader = Win32ReadDir()
1387
name0u = u'0file-\xb6'
1388
name1u = u'1dir-\u062c\u0648'
1389
name2u = u'2file-\u0633'
1393
name1u + '/' + name0u,
1394
name1u + '/' + name1u + '/',
1397
self.build_tree(tree)
1398
name0 = name0u.encode('utf8')
1399
name1 = name1u.encode('utf8')
1400
name2 = name2u.encode('utf8')
1402
# All of the abspaths should be in unicode, all of the relative paths
1404
expected_dirblocks = [
1406
[(name0, name0, 'file', './' + name0u),
1407
(name1, name1, 'directory', './' + name1u),
1408
(name2, name2, 'file', './' + name2u),
1411
((name1, './' + name1u),
1412
[(name1 + '/' + name0, name0, 'file', './' + name1u
1414
(name1 + '/' + name1, name1, 'directory', './' + name1u
1418
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1423
result = list(osutils._walkdirs_utf8(u'.'))
1424
self._filter_out_stat(result)
1425
self.assertEqual(expected_dirblocks, result)
1427
def assertStatIsCorrect(self, path, win32stat):
1428
os_stat = os.stat(path)
1429
self.assertEqual(os_stat.st_size, win32stat.st_size)
1430
self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
1431
self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
1432
self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
1433
self.assertEqual(os_stat.st_dev, win32stat.st_dev)
1434
self.assertEqual(os_stat.st_ino, win32stat.st_ino)
1435
self.assertEqual(os_stat.st_mode, win32stat.st_mode)
1437
def test__walkdirs_utf_win32_find_file_stat_file(self):
1438
"""make sure our Stat values are valid"""
1439
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1440
self.requireFeature(tests.UnicodeFilenameFeature)
1441
from bzrlib._walkdirs_win32 import Win32ReadDir
1442
name0u = u'0file-\xb6'
1443
name0 = name0u.encode('utf8')
1444
self.build_tree([name0u])
1445
# I hate to sleep() here, but I'm trying to make the ctime different
1448
f = open(name0u, 'ab')
1450
f.write('just a small update')
1454
result = Win32ReadDir().read_dir('', u'.')
1456
self.assertEqual((name0, name0, 'file'), entry[:3])
1457
self.assertEqual(u'./' + name0u, entry[4])
1458
self.assertStatIsCorrect(entry[4], entry[3])
1459
self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
1461
def test__walkdirs_utf_win32_find_file_stat_directory(self):
1462
"""make sure our Stat values are valid"""
1463
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1464
self.requireFeature(tests.UnicodeFilenameFeature)
1465
from bzrlib._walkdirs_win32 import Win32ReadDir
1466
name0u = u'0dir-\u062c\u0648'
1467
name0 = name0u.encode('utf8')
1468
self.build_tree([name0u + '/'])
1470
result = Win32ReadDir().read_dir('', u'.')
1472
self.assertEqual((name0, name0, 'directory'), entry[:3])
1473
self.assertEqual(u'./' + name0u, entry[4])
1474
self.assertStatIsCorrect(entry[4], entry[3])
311
('0file', '0file', 'file'),
312
('1dir', '1dir', 'directory'),
313
('2file', '2file', 'file'),
316
('1dir/0file', '0file', 'file'),
317
('1dir/1dir', '1dir', 'directory'),
324
for dirblock in osutils.walkdirs('.'):
325
if len(dirblock) and dirblock[0][1] == '.bzr':
326
# this tests the filtering of selected paths
329
result.append(dirblock)
331
self.assertTrue(found_bzrdir)
332
self.assertEqual(expected_dirblocks,
333
[[line[0:3] for line in block] for block in result])
334
# you can search a subdir only, with a supplied prefix.
336
for dirblock in osutils.walkdirs('1dir', '1dir'):
337
result.append(dirblock)
338
self.assertEqual(expected_dirblocks[1:],
339
[[line[0:3] for line in block] for block in result])
1476
341
def assertPathCompare(self, path_less, path_greater):
1477
342
"""check that path_less and path_greater compare correctly."""
1551
416
sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
1554
class TestCopyTree(tests.TestCaseInTempDir):
1556
def test_copy_basic_tree(self):
1557
self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1558
osutils.copy_tree('source', 'target')
1559
self.assertEqual(['a', 'b'], sorted(os.listdir('target')))
1560
self.assertEqual(['c'], os.listdir('target/b'))
1562
def test_copy_tree_target_exists(self):
1563
self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c',
1565
osutils.copy_tree('source', 'target')
1566
self.assertEqual(['a', 'b'], sorted(os.listdir('target')))
1567
self.assertEqual(['c'], os.listdir('target/b'))
1569
def test_copy_tree_symlinks(self):
1570
self.requireFeature(tests.SymlinkFeature)
1571
self.build_tree(['source/'])
1572
os.symlink('a/generic/path', 'source/lnk')
1573
osutils.copy_tree('source', 'target')
1574
self.assertEqual(['lnk'], os.listdir('target'))
1575
self.assertEqual('a/generic/path', os.readlink('target/lnk'))
1577
def test_copy_tree_handlers(self):
1578
processed_files = []
1579
processed_links = []
1580
def file_handler(from_path, to_path):
1581
processed_files.append(('f', from_path, to_path))
1582
def dir_handler(from_path, to_path):
1583
processed_files.append(('d', from_path, to_path))
1584
def link_handler(from_path, to_path):
1585
processed_links.append((from_path, to_path))
1586
handlers = {'file':file_handler,
1587
'directory':dir_handler,
1588
'symlink':link_handler,
1591
self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1592
if osutils.has_symlinks():
1593
os.symlink('a/generic/path', 'source/lnk')
1594
osutils.copy_tree('source', 'target', handlers=handlers)
1596
self.assertEqual([('d', 'source', 'target'),
1597
('f', 'source/a', 'target/a'),
1598
('d', 'source/b', 'target/b'),
1599
('f', 'source/b/c', 'target/b/c'),
1601
self.failIfExists('target')
1602
if osutils.has_symlinks():
1603
self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1606
class TestSetUnsetEnv(tests.TestCase):
1607
"""Test updating the environment"""
1610
super(TestSetUnsetEnv, self).setUp()
1612
self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'),
1613
'Environment was not cleaned up properly.'
1614
' Variable BZR_TEST_ENV_VAR should not exist.')
1616
if 'BZR_TEST_ENV_VAR' in os.environ:
1617
del os.environ['BZR_TEST_ENV_VAR']
1618
self.addCleanup(cleanup)
1621
"""Test that we can set an env variable"""
1622
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
1623
self.assertEqual(None, old)
1624
self.assertEqual('foo', os.environ.get('BZR_TEST_ENV_VAR'))
1626
def test_double_set(self):
1627
"""Test that we get the old value out"""
1628
osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
1629
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'bar')
1630
self.assertEqual('foo', old)
1631
self.assertEqual('bar', os.environ.get('BZR_TEST_ENV_VAR'))
1633
def test_unicode(self):
1634
"""Environment can only contain plain strings
1636
So Unicode strings must be encoded.
1638
uni_val, env_val = tests.probe_unicode_in_user_encoding()
1640
raise tests.TestSkipped(
1641
'Cannot find a unicode character that works in encoding %s'
1642
% (osutils.get_user_encoding(),))
1644
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
1645
self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
1647
def test_unset(self):
1648
"""Test that passing None will remove the env var"""
1649
osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
1650
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1651
self.assertEqual('foo', old)
1652
self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1653
self.failIf('BZR_TEST_ENV_VAR' in os.environ)
1656
class TestSizeShaFile(tests.TestCaseInTempDir):
1658
def test_sha_empty(self):
1659
self.build_tree_contents([('foo', '')])
1660
expected_sha = osutils.sha_string('')
1662
self.addCleanup(f.close)
1663
size, sha = osutils.size_sha_file(f)
1664
self.assertEqual(0, size)
1665
self.assertEqual(expected_sha, sha)
1667
def test_sha_mixed_endings(self):
1668
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1669
self.build_tree_contents([('foo', text)])
1670
expected_sha = osutils.sha_string(text)
1671
f = open('foo', 'rb')
1672
self.addCleanup(f.close)
1673
size, sha = osutils.size_sha_file(f)
1674
self.assertEqual(38, size)
1675
self.assertEqual(expected_sha, sha)
1678
class TestShaFileByName(tests.TestCaseInTempDir):
1680
def test_sha_empty(self):
1681
self.build_tree_contents([('foo', '')])
1682
expected_sha = osutils.sha_string('')
1683
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1685
def test_sha_mixed_endings(self):
1686
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1687
self.build_tree_contents([('foo', text)])
1688
expected_sha = osutils.sha_string(text)
1689
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1692
class TestResourceLoading(tests.TestCaseInTempDir):
1694
def test_resource_string(self):
1695
# test resource in bzrlib
1696
text = osutils.resource_string('bzrlib', 'debug.py')
1697
self.assertContainsRe(text, "debug_flags = set()")
1698
# test resource under bzrlib
1699
text = osutils.resource_string('bzrlib.ui', 'text.py')
1700
self.assertContainsRe(text, "class TextUIFactory")
1701
# test unsupported package
1702
self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
1704
# test unknown resource
1705
self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
1708
class TestReCompile(tests.TestCase):
1710
def _deprecated_re_compile_checked(self, *args, **kwargs):
1711
return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1712
osutils.re_compile_checked, *args, **kwargs)
1714
def test_re_compile_checked(self):
1715
r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1716
self.assertTrue(r.match('aaaa'))
1717
self.assertTrue(r.match('aAaA'))
1719
def test_re_compile_checked_error(self):
1720
# like https://bugs.launchpad.net/bzr/+bug/251352
1722
# Due to possible test isolation error, re.compile is not lazy at
1723
# this point. We re-install lazy compile.
1724
lazy_regex.install_lazy_compile()
1725
err = self.assertRaises(
1726
errors.BzrCommandError,
1727
self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1729
'Invalid regular expression in test case: '
1730
'"*" nothing to repeat',
1734
class TestDirReader(tests.TestCaseInTempDir):
1737
_dir_reader_class = None
1738
_native_to_unicode = None
1741
tests.TestCaseInTempDir.setUp(self)
1742
self.overrideAttr(osutils,
1743
'_selected_dir_reader', self._dir_reader_class())
1745
def _get_ascii_tree(self):
1753
expected_dirblocks = [
1755
[('0file', '0file', 'file'),
1756
('1dir', '1dir', 'directory'),
1757
('2file', '2file', 'file'),
1760
(('1dir', './1dir'),
1761
[('1dir/0file', '0file', 'file'),
1762
('1dir/1dir', '1dir', 'directory'),
1765
(('1dir/1dir', './1dir/1dir'),
1770
return tree, expected_dirblocks
1772
def test_walk_cur_dir(self):
1773
tree, expected_dirblocks = self._get_ascii_tree()
1774
self.build_tree(tree)
1775
result = list(osutils._walkdirs_utf8('.'))
1776
# Filter out stat and abspath
1777
self.assertEqual(expected_dirblocks,
1778
[(dirinfo, [line[0:3] for line in block])
1779
for dirinfo, block in result])
1781
def test_walk_sub_dir(self):
1782
tree, expected_dirblocks = self._get_ascii_tree()
1783
self.build_tree(tree)
1784
# you can search a subdir only, with a supplied prefix.
1785
result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
1786
# Filter out stat and abspath
1787
self.assertEqual(expected_dirblocks[1:],
1788
[(dirinfo, [line[0:3] for line in block])
1789
for dirinfo, block in result])
1791
def _get_unicode_tree(self):
1792
name0u = u'0file-\xb6'
1793
name1u = u'1dir-\u062c\u0648'
1794
name2u = u'2file-\u0633'
1798
name1u + '/' + name0u,
1799
name1u + '/' + name1u + '/',
1802
name0 = name0u.encode('UTF-8')
1803
name1 = name1u.encode('UTF-8')
1804
name2 = name2u.encode('UTF-8')
1805
expected_dirblocks = [
1807
[(name0, name0, 'file', './' + name0u),
1808
(name1, name1, 'directory', './' + name1u),
1809
(name2, name2, 'file', './' + name2u),
1812
((name1, './' + name1u),
1813
[(name1 + '/' + name0, name0, 'file', './' + name1u
1815
(name1 + '/' + name1, name1, 'directory', './' + name1u
1819
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1824
return tree, expected_dirblocks
1826
def _filter_out(self, raw_dirblocks):
1827
"""Filter out a walkdirs_utf8 result.
1829
stat field is removed, all native paths are converted to unicode
1831
filtered_dirblocks = []
1832
for dirinfo, block in raw_dirblocks:
1833
dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
1836
details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
1837
filtered_dirblocks.append((dirinfo, details))
1838
return filtered_dirblocks
1840
def test_walk_unicode_tree(self):
1841
self.requireFeature(tests.UnicodeFilenameFeature)
1842
tree, expected_dirblocks = self._get_unicode_tree()
1843
self.build_tree(tree)
1844
result = list(osutils._walkdirs_utf8('.'))
1845
self.assertEqual(expected_dirblocks, self._filter_out(result))
1847
def test_symlink(self):
1848
self.requireFeature(tests.SymlinkFeature)
1849
self.requireFeature(tests.UnicodeFilenameFeature)
1850
target = u'target\N{Euro Sign}'
1851
link_name = u'l\N{Euro Sign}nk'
1852
os.symlink(target, link_name)
1853
target_utf8 = target.encode('UTF-8')
1854
link_name_utf8 = link_name.encode('UTF-8')
1855
expected_dirblocks = [
1857
[(link_name_utf8, link_name_utf8,
1858
'symlink', './' + link_name),],
1860
result = list(osutils._walkdirs_utf8('.'))
1861
self.assertEqual(expected_dirblocks, self._filter_out(result))
1864
class TestReadLink(tests.TestCaseInTempDir):
1865
"""Exposes os.readlink() problems and the osutils solution.
1867
The only guarantee offered by os.readlink(), starting with 2.6, is that a
1868
unicode string will be returned if a unicode string is passed.
1870
But prior python versions failed to properly encode the passed unicode
1873
_test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
1876
super(tests.TestCaseInTempDir, self).setUp()
1877
self.link = u'l\N{Euro Sign}ink'
1878
self.target = u'targe\N{Euro Sign}t'
1879
os.symlink(self.target, self.link)
1881
def test_os_readlink_link_encoding(self):
1882
if sys.version_info < (2, 6):
1883
self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
1885
self.assertEquals(self.target, os.readlink(self.link))
1887
def test_os_readlink_link_decoding(self):
1888
self.assertEquals(self.target.encode(osutils._fs_enc),
1889
os.readlink(self.link.encode(osutils._fs_enc)))
1892
class TestConcurrency(tests.TestCase):
1895
super(TestConcurrency, self).setUp()
1896
self.overrideAttr(osutils, '_cached_local_concurrency')
1898
def test_local_concurrency(self):
1899
concurrency = osutils.local_concurrency()
1900
self.assertIsInstance(concurrency, int)
1902
def test_local_concurrency_environment_variable(self):
1903
os.environ['BZR_CONCURRENCY'] = '2'
1904
self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1905
os.environ['BZR_CONCURRENCY'] = '3'
1906
self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1907
os.environ['BZR_CONCURRENCY'] = 'foo'
1908
self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1910
def test_option_concurrency(self):
1911
os.environ['BZR_CONCURRENCY'] = '1'
1912
self.run_bzr('rocks --concurrency 42')
1913
# Command line overrides envrionment variable
1914
self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1915
self.assertEquals(42, osutils.local_concurrency(use_cache=False))
1918
class TestFailedToLoadExtension(tests.TestCase):
1920
def _try_loading(self):
1922
import bzrlib._fictional_extension_py
1923
except ImportError, e:
1924
osutils.failed_to_load_extension(e)
1928
super(TestFailedToLoadExtension, self).setUp()
1929
self.overrideAttr(osutils, '_extension_load_failures', [])
1931
def test_failure_to_load(self):
1933
self.assertLength(1, osutils._extension_load_failures)
1934
self.assertEquals(osutils._extension_load_failures[0],
1935
"No module named _fictional_extension_py")
1937
def test_report_extension_load_failures_no_warning(self):
1938
self.assertTrue(self._try_loading())
1939
warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
1940
# it used to give a Python warning; it no longer does
1941
self.assertLength(0, warnings)
1943
def test_report_extension_load_failures_message(self):
1945
trace.push_log_file(log)
1946
self.assertTrue(self._try_loading())
1947
osutils.report_extension_load_failures()
1948
self.assertContainsRe(
1950
r"bzr: warning: some compiled extensions could not be loaded; "
1951
"see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
1955
class TestTerminalWidth(tests.TestCase):
1958
tests.TestCase.setUp(self)
1959
self._orig_terminal_size_state = osutils._terminal_size_state
1960
self._orig_first_terminal_size = osutils._first_terminal_size
1961
self.addCleanup(self.restore_osutils_globals)
1962
osutils._terminal_size_state = 'no_data'
1963
osutils._first_terminal_size = None
1965
def restore_osutils_globals(self):
1966
osutils._terminal_size_state = self._orig_terminal_size_state
1967
osutils._first_terminal_size = self._orig_first_terminal_size
1969
def replace_stdout(self, new):
1970
self.overrideAttr(sys, 'stdout', new)
1972
def replace__terminal_size(self, new):
1973
self.overrideAttr(osutils, '_terminal_size', new)
1975
def set_fake_tty(self):
1977
class I_am_a_tty(object):
1981
self.replace_stdout(I_am_a_tty())
1983
def test_default_values(self):
1984
self.assertEqual(80, osutils.default_terminal_width)
1986
def test_defaults_to_BZR_COLUMNS(self):
1987
# BZR_COLUMNS is set by the test framework
1988
self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
1989
os.environ['BZR_COLUMNS'] = '12'
1990
self.assertEqual(12, osutils.terminal_width())
1992
def test_falls_back_to_COLUMNS(self):
1993
del os.environ['BZR_COLUMNS']
1994
self.assertNotEqual('42', os.environ['COLUMNS'])
1996
os.environ['COLUMNS'] = '42'
1997
self.assertEqual(42, osutils.terminal_width())
1999
def test_tty_default_without_columns(self):
2000
del os.environ['BZR_COLUMNS']
2001
del os.environ['COLUMNS']
2003
def terminal_size(w, h):
2007
# We need to override the osutils definition as it depends on the
2008
# running environment that we can't control (PQM running without a
2009
# controlling terminal is one example).
2010
self.replace__terminal_size(terminal_size)
2011
self.assertEqual(42, osutils.terminal_width())
2013
def test_non_tty_default_without_columns(self):
2014
del os.environ['BZR_COLUMNS']
2015
del os.environ['COLUMNS']
2016
self.replace_stdout(None)
2017
self.assertEqual(None, osutils.terminal_width())
2019
def test_no_TIOCGWINSZ(self):
2020
self.requireFeature(term_ios_feature)
2021
termios = term_ios_feature.module
2022
# bug 63539 is about a termios without TIOCGWINSZ attribute
2024
orig = termios.TIOCGWINSZ
2025
except AttributeError:
2026
# We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
2029
self.overrideAttr(termios, 'TIOCGWINSZ')
2030
del termios.TIOCGWINSZ
2031
del os.environ['BZR_COLUMNS']
2032
del os.environ['COLUMNS']
2033
# Whatever the result is, if we don't raise an exception, it's ok.
2034
osutils.terminal_width()
2036
class TestCreationOps(tests.TestCaseInTempDir):
2037
_test_needs_features = [features.chown_feature]
2040
tests.TestCaseInTempDir.setUp(self)
2041
self.overrideAttr(os, 'chown', self._dummy_chown)
2043
# params set by call to _dummy_chown
2044
self.path = self.uid = self.gid = None
2046
def _dummy_chown(self, path, uid, gid):
2047
self.path, self.uid, self.gid = path, uid, gid
2049
def test_copy_ownership_from_path(self):
2050
"""copy_ownership_from_path test with specified src."""
2052
f = open('test_file', 'wt')
2053
osutils.copy_ownership_from_path('test_file', ownsrc)
2056
self.assertEquals(self.path, 'test_file')
2057
self.assertEquals(self.uid, s.st_uid)
2058
self.assertEquals(self.gid, s.st_gid)
2060
def test_copy_ownership_nonesrc(self):
2061
"""copy_ownership_from_path test with src=None."""
2062
f = open('test_file', 'wt')
2063
# should use parent dir for permissions
2064
osutils.copy_ownership_from_path('test_file')
2067
self.assertEquals(self.path, 'test_file')
2068
self.assertEquals(self.uid, s.st_uid)
2069
self.assertEquals(self.gid, s.st_gid)
2071
class TestGetuserUnicode(tests.TestCase):
2073
def test_ascii_user(self):
2074
osutils.set_or_unset_env('LOGNAME', 'jrandom')
2075
self.assertEqual(u'jrandom', osutils.getuser_unicode())
2077
def test_unicode_user(self):
2078
ue = osutils.get_user_encoding()
2079
osutils.set_or_unset_env('LOGNAME', u'jrandom\xb6'.encode(ue))
2080
self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
419
class TestTerminalEncoding(TestCase):
420
"""Test the auto-detection of proper terminal encoding."""
423
self._stdout = sys.stdout
424
self._stderr = sys.stderr
425
self._stdin = sys.stdin
426
self._user_encoding = bzrlib.user_encoding
428
self.addCleanup(self._reset)
430
sys.stdout = StringIOWrapper()
431
sys.stdout.encoding = 'stdout_encoding'
432
sys.stderr = StringIOWrapper()
433
sys.stderr.encoding = 'stderr_encoding'
434
sys.stdin = StringIOWrapper()
435
sys.stdin.encoding = 'stdin_encoding'
436
bzrlib.user_encoding = 'user_encoding'
439
sys.stdout = self._stdout
440
sys.stderr = self._stderr
441
sys.stdin = self._stdin
442
bzrlib.user_encoding = self._user_encoding
444
def test_get_terminal_encoding(self):
445
# first preference is stdout encoding
446
self.assertEqual('stdout_encoding', osutils.get_terminal_encoding())
448
sys.stdout.encoding = None
449
# if sys.stdout is None, fall back to sys.stdin
450
self.assertEqual('stdin_encoding', osutils.get_terminal_encoding())
452
sys.stdin.encoding = None
453
# and in the worst case, use bzrlib.user_encoding
454
self.assertEqual('user_encoding', osutils.get_terminal_encoding())
added
removed
bzrlib/tests/test_osutils.py
