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
27
26
from bzrlib import (
31
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
32
from bzrlib.osutils import (
34
is_inside_or_parent_of_any,
36
37
from bzrlib.tests import (
41
from bzrlib.tests.scenarios import load_tests_apply_scenarios
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
load_tests = load_tests_apply_scenarios
103
class TestContainsWhitespace(tests.TestCase):
38
probe_unicode_in_user_encoding,
47
class TestOSUtils(TestCaseInTempDir):
105
49
def test_contains_whitespace(self):
106
self.assertTrue(osutils.contains_whitespace(u' '))
107
self.assertTrue(osutils.contains_whitespace(u'hello there'))
108
self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
109
self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
110
self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
111
self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
50
self.failUnless(osutils.contains_whitespace(u' '))
51
self.failUnless(osutils.contains_whitespace(u'hello there'))
52
self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
53
self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
54
self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
55
self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
113
57
# \xa0 is "Non-breaking-space" which on some python locales thinks it
114
58
# is whitespace, but we do not.
115
self.assertFalse(osutils.contains_whitespace(u''))
116
self.assertFalse(osutils.contains_whitespace(u'hellothere'))
117
self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
120
class TestRename(tests.TestCaseInTempDir):
122
def create_file(self, filename, content):
123
f = open(filename, 'wb')
129
def _fancy_rename(self, a, b):
130
osutils.fancy_rename(a, b, rename_func=os.rename,
131
unlink_func=os.unlink)
59
self.failIf(osutils.contains_whitespace(u''))
60
self.failIf(osutils.contains_whitespace(u'hellothere'))
61
self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
133
63
def test_fancy_rename(self):
134
64
# This should work everywhere
135
self.create_file('a', 'something in a\n')
136
self._fancy_rename('a', 'b')
137
self.assertPathDoesNotExist('a')
138
self.assertPathExists('b')
66
osutils.fancy_rename(a, b,
67
rename_func=os.rename,
68
unlink_func=os.unlink)
70
open('a', 'wb').write('something in a\n')
72
self.failIfExists('a')
73
self.failUnlessExists('b')
139
74
self.check_file_contents('b', 'something in a\n')
141
self.create_file('a', 'new something in a\n')
142
self._fancy_rename('b', 'a')
76
open('a', 'wb').write('new something in a\n')
144
79
self.check_file_contents('a', 'something in a\n')
146
def test_fancy_rename_fails_source_missing(self):
147
# An exception should be raised, and the target should be left in place
148
self.create_file('target', 'data in target\n')
149
self.assertRaises((IOError, OSError), self._fancy_rename,
150
'missingsource', 'target')
151
self.assertPathExists('target')
152
self.check_file_contents('target', 'data in target\n')
154
def test_fancy_rename_fails_if_source_and_target_missing(self):
155
self.assertRaises((IOError, OSError), self._fancy_rename,
156
'missingsource', 'missingtarget')
158
81
def test_rename(self):
159
82
# Rename should be semi-atomic on all platforms
160
self.create_file('a', 'something in a\n')
83
open('a', 'wb').write('something in a\n')
161
84
osutils.rename('a', 'b')
162
self.assertPathDoesNotExist('a')
163
self.assertPathExists('b')
85
self.failIfExists('a')
86
self.failUnlessExists('b')
164
87
self.check_file_contents('b', 'something in a\n')
166
self.create_file('a', 'new something in a\n')
89
open('a', 'wb').write('new something in a\n')
167
90
osutils.rename('b', 'a')
169
92
self.check_file_contents('a', 'something in a\n')
476
308
osutils.make_readonly('dangling')
477
309
osutils.make_writable('dangling')
479
def test_host_os_dereferences_symlinks(self):
480
osutils.host_os_dereferences_symlinks()
483
class TestCanonicalRelPath(tests.TestCaseInTempDir):
485
_test_needs_features = [tests.CaseInsCasePresFilenameFeature]
487
def test_canonical_relpath_simple(self):
488
f = file('MixedCaseName', 'w')
490
actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
491
self.assertEqual('work/MixedCaseName', actual)
493
def test_canonical_relpath_missing_tail(self):
494
os.mkdir('MixedCaseParent')
495
actual = osutils.canonical_relpath(self.test_base_dir,
496
'mixedcaseparent/nochild')
497
self.assertEqual('work/MixedCaseParent/nochild', actual)
500
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
502
def assertRelpath(self, expected, base, path):
503
actual = osutils._cicp_canonical_relpath(base, path)
504
self.assertEqual(expected, actual)
506
def test_simple(self):
507
self.build_tree(['MixedCaseName'])
508
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
509
self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
511
def test_subdir_missing_tail(self):
512
self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
513
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
514
self.assertRelpath('MixedCaseParent/a_child', base,
515
'MixedCaseParent/a_child')
516
self.assertRelpath('MixedCaseParent/a_child', base,
517
'MixedCaseParent/A_Child')
518
self.assertRelpath('MixedCaseParent/not_child', base,
519
'MixedCaseParent/not_child')
521
def test_at_root_slash(self):
522
# We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
524
if osutils.MIN_ABS_PATHLENGTH > 1:
525
raise tests.TestSkipped('relpath requires %d chars'
526
% osutils.MIN_ABS_PATHLENGTH)
527
self.assertRelpath('foo', '/', '/foo')
529
def test_at_root_drive(self):
530
if sys.platform != 'win32':
531
raise tests.TestNotApplicable('we can only test drive-letter relative'
532
' paths on Windows where we have drive'
535
# The specific issue is that when at the root of a drive, 'abspath'
536
# returns "C:/" or just "/". However, the code assumes that abspath
537
# always returns something like "C:/foo" or "/foo" (no trailing slash).
538
self.assertRelpath('foo', 'C:/', 'C:/foo')
539
self.assertRelpath('foo', 'X:/', 'X:/foo')
540
self.assertRelpath('foo', 'X:/', 'X://foo')
543
class TestPumpFile(tests.TestCase):
544
"""Test pumpfile method."""
547
tests.TestCase.setUp(self)
548
# create a test datablock
549
self.block_size = 512
550
pattern = '0123456789ABCDEF'
551
self.test_data = pattern * (3 * self.block_size / len(pattern))
552
self.test_data_len = len(self.test_data)
554
def test_bracket_block_size(self):
555
"""Read data in blocks with the requested read size bracketing the
557
# make sure test data is larger than max read size
558
self.assertTrue(self.test_data_len > self.block_size)
560
from_file = file_utils.FakeReadFile(self.test_data)
563
# read (max / 2) bytes and verify read size wasn't affected
564
num_bytes_to_read = self.block_size / 2
565
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
566
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
567
self.assertEqual(from_file.get_read_count(), 1)
569
# read (max) bytes and verify read size wasn't affected
570
num_bytes_to_read = self.block_size
571
from_file.reset_read_count()
572
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
573
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
574
self.assertEqual(from_file.get_read_count(), 1)
576
# read (max + 1) bytes and verify read size was limited
577
num_bytes_to_read = self.block_size + 1
578
from_file.reset_read_count()
579
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
580
self.assertEqual(from_file.get_max_read_size(), self.block_size)
581
self.assertEqual(from_file.get_read_count(), 2)
583
# finish reading the rest of the data
584
num_bytes_to_read = self.test_data_len - to_file.tell()
585
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
587
# report error if the data wasn't equal (we only report the size due
588
# to the length of the data)
589
response_data = to_file.getvalue()
590
if response_data != self.test_data:
591
message = "Data not equal. Expected %d bytes, received %d."
592
self.fail(message % (len(response_data), self.test_data_len))
594
def test_specified_size(self):
595
"""Request a transfer larger than the maximum block size and verify
596
that the maximum read doesn't exceed the block_size."""
597
# make sure test data is larger than max read size
598
self.assertTrue(self.test_data_len > self.block_size)
600
# retrieve data in blocks
601
from_file = file_utils.FakeReadFile(self.test_data)
603
osutils.pumpfile(from_file, to_file, self.test_data_len,
606
# verify read size was equal to the maximum read size
607
self.assertTrue(from_file.get_max_read_size() > 0)
608
self.assertEqual(from_file.get_max_read_size(), self.block_size)
609
self.assertEqual(from_file.get_read_count(), 3)
611
# report error if the data wasn't equal (we only report the size due
612
# to the length of the data)
613
response_data = to_file.getvalue()
614
if response_data != self.test_data:
615
message = "Data not equal. Expected %d bytes, received %d."
616
self.fail(message % (len(response_data), self.test_data_len))
618
def test_to_eof(self):
619
"""Read to end-of-file and verify that the reads are not larger than
620
the maximum read size."""
621
# make sure test data is larger than max read size
622
self.assertTrue(self.test_data_len > self.block_size)
624
# retrieve data to EOF
625
from_file = file_utils.FakeReadFile(self.test_data)
627
osutils.pumpfile(from_file, to_file, -1, self.block_size)
629
# verify read size was equal to the maximum read size
630
self.assertEqual(from_file.get_max_read_size(), self.block_size)
631
self.assertEqual(from_file.get_read_count(), 4)
633
# report error if the data wasn't equal (we only report the size due
634
# to the length of the data)
635
response_data = to_file.getvalue()
636
if response_data != self.test_data:
637
message = "Data not equal. Expected %d bytes, received %d."
638
self.fail(message % (len(response_data), self.test_data_len))
640
def test_defaults(self):
641
"""Verifies that the default arguments will read to EOF -- this
642
test verifies that any existing usages of pumpfile will not be broken
643
with this new version."""
644
# retrieve data using default (old) pumpfile method
645
from_file = file_utils.FakeReadFile(self.test_data)
647
osutils.pumpfile(from_file, to_file)
649
# report error if the data wasn't equal (we only report the size due
650
# to the length of the data)
651
response_data = to_file.getvalue()
652
if response_data != self.test_data:
653
message = "Data not equal. Expected %d bytes, received %d."
654
self.fail(message % (len(response_data), self.test_data_len))
656
def test_report_activity(self):
658
def log_activity(length, direction):
659
activity.append((length, direction))
660
from_file = StringIO(self.test_data)
662
osutils.pumpfile(from_file, to_file, buff_size=500,
663
report_activity=log_activity, direction='read')
664
self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
665
(36, 'read')], activity)
667
from_file = StringIO(self.test_data)
670
osutils.pumpfile(from_file, to_file, buff_size=500,
671
report_activity=log_activity, direction='write')
672
self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
673
(36, 'write')], activity)
675
# And with a limited amount of data
676
from_file = StringIO(self.test_data)
679
osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
680
report_activity=log_activity, direction='read')
681
self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
685
class TestPumpStringFile(tests.TestCase):
687
def test_empty(self):
689
osutils.pump_string_file("", output)
690
self.assertEqual("", output.getvalue())
692
def test_more_than_segment_size(self):
694
osutils.pump_string_file("123456789", output, 2)
695
self.assertEqual("123456789", output.getvalue())
697
def test_segment_size(self):
699
osutils.pump_string_file("12", output, 2)
700
self.assertEqual("12", output.getvalue())
702
def test_segment_size_multiple(self):
704
osutils.pump_string_file("1234", output, 2)
705
self.assertEqual("1234", output.getvalue())
708
class TestRelpath(tests.TestCase):
710
def test_simple_relpath(self):
711
cwd = osutils.getcwd()
712
subdir = cwd + '/subdir'
713
self.assertEqual('subdir', osutils.relpath(cwd, subdir))
715
def test_deep_relpath(self):
716
cwd = osutils.getcwd()
717
subdir = cwd + '/sub/subsubdir'
718
self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
720
def test_not_relative(self):
721
self.assertRaises(errors.PathNotChild,
722
osutils.relpath, 'C:/path', 'H:/path')
723
self.assertRaises(errors.PathNotChild,
724
osutils.relpath, 'C:/', 'H:/path')
727
class TestSafeUnicode(tests.TestCase):
311
def test_kind_marker(self):
312
self.assertEqual("", osutils.kind_marker("file"))
313
self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
314
self.assertEqual("@", osutils.kind_marker("symlink"))
315
self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
318
class TestSafeUnicode(TestCase):
729
320
def test_from_ascii_string(self):
730
321
self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
1344
804
result.append((dirdetail, new_dirblock))
1345
805
self.assertEqual(expected_dirblocks, result)
1347
def test__walkdirs_utf8_with_unicode_fs(self):
1348
"""UnicodeDirReader should be a safe fallback everywhere
807
def test_unicode__walkdirs_unicode_to_utf8(self):
808
"""walkdirs_unicode_to_utf8 should be a safe fallback everywhere
1350
810
The abspath portion should be in unicode
1352
self.requireFeature(tests.UnicodeFilenameFeature)
1353
# Use the unicode reader. TODO: split into driver-and-driven unit
1355
self._save_platform_info()
1356
osutils._selected_dir_reader = osutils.UnicodeDirReader()
1357
name0u = u'0file-\xb6'
1358
name1u = u'1dir-\u062c\u0648'
1359
name2u = u'2file-\u0633'
1363
name1u + '/' + name0u,
1364
name1u + '/' + name1u + '/',
1367
self.build_tree(tree)
1368
name0 = name0u.encode('utf8')
1369
name1 = name1u.encode('utf8')
1370
name2 = name2u.encode('utf8')
1372
# All of the abspaths should be in unicode, all of the relative paths
1374
expected_dirblocks = [
1376
[(name0, name0, 'file', './' + name0u),
1377
(name1, name1, 'directory', './' + name1u),
1378
(name2, name2, 'file', './' + name2u),
1381
((name1, './' + name1u),
1382
[(name1 + '/' + name0, name0, 'file', './' + name1u
1384
(name1 + '/' + name1, name1, 'directory', './' + name1u
1388
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1393
result = list(osutils._walkdirs_utf8('.'))
1394
self._filter_out_stat(result)
1395
self.assertEqual(expected_dirblocks, result)
1397
def test__walkdirs_utf8_win32readdir(self):
1398
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1399
self.requireFeature(tests.UnicodeFilenameFeature)
1400
from bzrlib._walkdirs_win32 import Win32ReadDir
1401
self._save_platform_info()
1402
osutils._selected_dir_reader = Win32ReadDir()
1403
name0u = u'0file-\xb6'
1404
name1u = u'1dir-\u062c\u0648'
1405
name2u = u'2file-\u0633'
1409
name1u + '/' + name0u,
1410
name1u + '/' + name1u + '/',
1413
self.build_tree(tree)
1414
name0 = name0u.encode('utf8')
1415
name1 = name1u.encode('utf8')
1416
name2 = name2u.encode('utf8')
1418
# All of the abspaths should be in unicode, all of the relative paths
1420
expected_dirblocks = [
1422
[(name0, name0, 'file', './' + name0u),
1423
(name1, name1, 'directory', './' + name1u),
1424
(name2, name2, 'file', './' + name2u),
1427
((name1, './' + name1u),
1428
[(name1 + '/' + name0, name0, 'file', './' + name1u
1430
(name1 + '/' + name1, name1, 'directory', './' + name1u
1434
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1439
result = list(osutils._walkdirs_utf8(u'.'))
1440
self._filter_out_stat(result)
1441
self.assertEqual(expected_dirblocks, result)
1443
def assertStatIsCorrect(self, path, win32stat):
1444
os_stat = os.stat(path)
1445
self.assertEqual(os_stat.st_size, win32stat.st_size)
1446
self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
1447
self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
1448
self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
1449
self.assertEqual(os_stat.st_dev, win32stat.st_dev)
1450
self.assertEqual(os_stat.st_ino, win32stat.st_ino)
1451
self.assertEqual(os_stat.st_mode, win32stat.st_mode)
1453
def test__walkdirs_utf_win32_find_file_stat_file(self):
1454
"""make sure our Stat values are valid"""
1455
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1456
self.requireFeature(tests.UnicodeFilenameFeature)
1457
from bzrlib._walkdirs_win32 import Win32ReadDir
1458
name0u = u'0file-\xb6'
1459
name0 = name0u.encode('utf8')
1460
self.build_tree([name0u])
1461
# I hate to sleep() here, but I'm trying to make the ctime different
1464
f = open(name0u, 'ab')
812
name0u = u'0file-\xb6'
813
name1u = u'1dir-\u062c\u0648'
814
name2u = u'2file-\u0633'
818
name1u + '/' + name0u,
819
name1u + '/' + name1u + '/',
1466
f.write('just a small update')
1470
result = Win32ReadDir().read_dir('', u'.')
1472
self.assertEqual((name0, name0, 'file'), entry[:3])
1473
self.assertEqual(u'./' + name0u, entry[4])
1474
self.assertStatIsCorrect(entry[4], entry[3])
1475
self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
1477
def test__walkdirs_utf_win32_find_file_stat_directory(self):
1478
"""make sure our Stat values are valid"""
1479
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1480
self.requireFeature(tests.UnicodeFilenameFeature)
1481
from bzrlib._walkdirs_win32 import Win32ReadDir
1482
name0u = u'0dir-\u062c\u0648'
823
self.build_tree(tree)
825
raise TestSkipped('Could not represent Unicode chars'
826
' in current encoding.')
1483
827
name0 = name0u.encode('utf8')
1484
self.build_tree([name0u + '/'])
828
name1 = name1u.encode('utf8')
829
name2 = name2u.encode('utf8')
1486
result = Win32ReadDir().read_dir('', u'.')
1488
self.assertEqual((name0, name0, 'directory'), entry[:3])
1489
self.assertEqual(u'./' + name0u, entry[4])
1490
self.assertStatIsCorrect(entry[4], entry[3])
831
# All of the abspaths should be in unicode, all of the relative paths
833
expected_dirblocks = [
835
[(name0, name0, 'file', './' + name0u),
836
(name1, name1, 'directory', './' + name1u),
837
(name2, name2, 'file', './' + name2u),
840
((name1, './' + name1u),
841
[(name1 + '/' + name0, name0, 'file', './' + name1u
843
(name1 + '/' + name1, name1, 'directory', './' + name1u
847
((name1 + '/' + name1, './' + name1u + '/' + name1u),
852
result = list(osutils._walkdirs_unicode_to_utf8('.'))
853
self._filter_out_stat(result)
854
self.assertEqual(expected_dirblocks, result)
1492
856
def assertPathCompare(self, path_less, path_greater):
1493
857
"""check that path_less and path_greater compare correctly."""
1666
1034
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1667
1035
self.assertEqual('foo', old)
1668
1036
self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1669
self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1672
class TestSizeShaFile(tests.TestCaseInTempDir):
1674
def test_sha_empty(self):
1675
self.build_tree_contents([('foo', '')])
1676
expected_sha = osutils.sha_string('')
1678
self.addCleanup(f.close)
1679
size, sha = osutils.size_sha_file(f)
1680
self.assertEqual(0, size)
1681
self.assertEqual(expected_sha, sha)
1683
def test_sha_mixed_endings(self):
1684
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1685
self.build_tree_contents([('foo', text)])
1686
expected_sha = osutils.sha_string(text)
1687
f = open('foo', 'rb')
1688
self.addCleanup(f.close)
1689
size, sha = osutils.size_sha_file(f)
1690
self.assertEqual(38, size)
1691
self.assertEqual(expected_sha, sha)
1694
class TestShaFileByName(tests.TestCaseInTempDir):
1696
def test_sha_empty(self):
1697
self.build_tree_contents([('foo', '')])
1698
expected_sha = osutils.sha_string('')
1699
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1701
def test_sha_mixed_endings(self):
1702
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1703
self.build_tree_contents([('foo', text)])
1704
expected_sha = osutils.sha_string(text)
1705
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1708
class TestResourceLoading(tests.TestCaseInTempDir):
1710
def test_resource_string(self):
1711
# test resource in bzrlib
1712
text = osutils.resource_string('bzrlib', 'debug.py')
1713
self.assertContainsRe(text, "debug_flags = set()")
1714
# test resource under bzrlib
1715
text = osutils.resource_string('bzrlib.ui', 'text.py')
1716
self.assertContainsRe(text, "class TextUIFactory")
1717
# test unsupported package
1718
self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
1720
# test unknown resource
1721
self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
1724
class TestReCompile(tests.TestCase):
1726
def _deprecated_re_compile_checked(self, *args, **kwargs):
1727
return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1728
osutils.re_compile_checked, *args, **kwargs)
1730
def test_re_compile_checked(self):
1731
r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1732
self.assertTrue(r.match('aaaa'))
1733
self.assertTrue(r.match('aAaA'))
1735
def test_re_compile_checked_error(self):
1736
# like https://bugs.launchpad.net/bzr/+bug/251352
1738
# Due to possible test isolation error, re.compile is not lazy at
1739
# this point. We re-install lazy compile.
1740
lazy_regex.install_lazy_compile()
1741
err = self.assertRaises(
1742
errors.BzrCommandError,
1743
self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1745
'Invalid regular expression in test case: '
1746
'"*" nothing to repeat',
1750
class TestDirReader(tests.TestCaseInTempDir):
1752
scenarios = dir_reader_scenarios()
1755
_dir_reader_class = None
1756
_native_to_unicode = None
1759
tests.TestCaseInTempDir.setUp(self)
1760
self.overrideAttr(osutils,
1761
'_selected_dir_reader', self._dir_reader_class())
1763
def _get_ascii_tree(self):
1771
expected_dirblocks = [
1773
[('0file', '0file', 'file'),
1774
('1dir', '1dir', 'directory'),
1775
('2file', '2file', 'file'),
1778
(('1dir', './1dir'),
1779
[('1dir/0file', '0file', 'file'),
1780
('1dir/1dir', '1dir', 'directory'),
1783
(('1dir/1dir', './1dir/1dir'),
1788
return tree, expected_dirblocks
1790
def test_walk_cur_dir(self):
1791
tree, expected_dirblocks = self._get_ascii_tree()
1792
self.build_tree(tree)
1793
result = list(osutils._walkdirs_utf8('.'))
1794
# Filter out stat and abspath
1795
self.assertEqual(expected_dirblocks,
1796
[(dirinfo, [line[0:3] for line in block])
1797
for dirinfo, block in result])
1799
def test_walk_sub_dir(self):
1800
tree, expected_dirblocks = self._get_ascii_tree()
1801
self.build_tree(tree)
1802
# you can search a subdir only, with a supplied prefix.
1803
result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
1804
# Filter out stat and abspath
1805
self.assertEqual(expected_dirblocks[1:],
1806
[(dirinfo, [line[0:3] for line in block])
1807
for dirinfo, block in result])
1809
def _get_unicode_tree(self):
1810
name0u = u'0file-\xb6'
1811
name1u = u'1dir-\u062c\u0648'
1812
name2u = u'2file-\u0633'
1816
name1u + '/' + name0u,
1817
name1u + '/' + name1u + '/',
1820
name0 = name0u.encode('UTF-8')
1821
name1 = name1u.encode('UTF-8')
1822
name2 = name2u.encode('UTF-8')
1823
expected_dirblocks = [
1825
[(name0, name0, 'file', './' + name0u),
1826
(name1, name1, 'directory', './' + name1u),
1827
(name2, name2, 'file', './' + name2u),
1830
((name1, './' + name1u),
1831
[(name1 + '/' + name0, name0, 'file', './' + name1u
1833
(name1 + '/' + name1, name1, 'directory', './' + name1u
1837
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1842
return tree, expected_dirblocks
1844
def _filter_out(self, raw_dirblocks):
1845
"""Filter out a walkdirs_utf8 result.
1847
stat field is removed, all native paths are converted to unicode
1849
filtered_dirblocks = []
1850
for dirinfo, block in raw_dirblocks:
1851
dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
1854
details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
1855
filtered_dirblocks.append((dirinfo, details))
1856
return filtered_dirblocks
1858
def test_walk_unicode_tree(self):
1859
self.requireFeature(tests.UnicodeFilenameFeature)
1860
tree, expected_dirblocks = self._get_unicode_tree()
1861
self.build_tree(tree)
1862
result = list(osutils._walkdirs_utf8('.'))
1863
self.assertEqual(expected_dirblocks, self._filter_out(result))
1865
def test_symlink(self):
1866
self.requireFeature(tests.SymlinkFeature)
1867
self.requireFeature(tests.UnicodeFilenameFeature)
1868
target = u'target\N{Euro Sign}'
1869
link_name = u'l\N{Euro Sign}nk'
1870
os.symlink(target, link_name)
1871
target_utf8 = target.encode('UTF-8')
1872
link_name_utf8 = link_name.encode('UTF-8')
1873
expected_dirblocks = [
1875
[(link_name_utf8, link_name_utf8,
1876
'symlink', './' + link_name),],
1878
result = list(osutils._walkdirs_utf8('.'))
1879
self.assertEqual(expected_dirblocks, self._filter_out(result))
1882
class TestReadLink(tests.TestCaseInTempDir):
1883
"""Exposes os.readlink() problems and the osutils solution.
1885
The only guarantee offered by os.readlink(), starting with 2.6, is that a
1886
unicode string will be returned if a unicode string is passed.
1888
But prior python versions failed to properly encode the passed unicode
1891
_test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
1894
super(tests.TestCaseInTempDir, self).setUp()
1895
self.link = u'l\N{Euro Sign}ink'
1896
self.target = u'targe\N{Euro Sign}t'
1897
os.symlink(self.target, self.link)
1899
def test_os_readlink_link_encoding(self):
1900
if sys.version_info < (2, 6):
1901
self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
1903
self.assertEquals(self.target, os.readlink(self.link))
1905
def test_os_readlink_link_decoding(self):
1906
self.assertEquals(self.target.encode(osutils._fs_enc),
1907
os.readlink(self.link.encode(osutils._fs_enc)))
1910
class TestConcurrency(tests.TestCase):
1913
super(TestConcurrency, self).setUp()
1914
self.overrideAttr(osutils, '_cached_local_concurrency')
1916
def test_local_concurrency(self):
1917
concurrency = osutils.local_concurrency()
1918
self.assertIsInstance(concurrency, int)
1920
def test_local_concurrency_environment_variable(self):
1921
self.overrideEnv('BZR_CONCURRENCY', '2')
1922
self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1923
self.overrideEnv('BZR_CONCURRENCY', '3')
1924
self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1925
self.overrideEnv('BZR_CONCURRENCY', 'foo')
1926
self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1928
def test_option_concurrency(self):
1929
self.overrideEnv('BZR_CONCURRENCY', '1')
1930
self.run_bzr('rocks --concurrency 42')
1931
# Command line overrides environment variable
1932
self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1933
self.assertEquals(42, osutils.local_concurrency(use_cache=False))
1936
class TestFailedToLoadExtension(tests.TestCase):
1938
def _try_loading(self):
1940
import bzrlib._fictional_extension_py
1941
except ImportError, e:
1942
osutils.failed_to_load_extension(e)
1946
super(TestFailedToLoadExtension, self).setUp()
1947
self.overrideAttr(osutils, '_extension_load_failures', [])
1949
def test_failure_to_load(self):
1951
self.assertLength(1, osutils._extension_load_failures)
1952
self.assertEquals(osutils._extension_load_failures[0],
1953
"No module named _fictional_extension_py")
1955
def test_report_extension_load_failures_no_warning(self):
1956
self.assertTrue(self._try_loading())
1957
warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
1958
# it used to give a Python warning; it no longer does
1959
self.assertLength(0, warnings)
1961
def test_report_extension_load_failures_message(self):
1963
trace.push_log_file(log)
1964
self.assertTrue(self._try_loading())
1965
osutils.report_extension_load_failures()
1966
self.assertContainsRe(
1968
r"bzr: warning: some compiled extensions could not be loaded; "
1969
"see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
1973
class TestTerminalWidth(tests.TestCase):
1976
tests.TestCase.setUp(self)
1977
self._orig_terminal_size_state = osutils._terminal_size_state
1978
self._orig_first_terminal_size = osutils._first_terminal_size
1979
self.addCleanup(self.restore_osutils_globals)
1980
osutils._terminal_size_state = 'no_data'
1981
osutils._first_terminal_size = None
1983
def restore_osutils_globals(self):
1984
osutils._terminal_size_state = self._orig_terminal_size_state
1985
osutils._first_terminal_size = self._orig_first_terminal_size
1987
def replace_stdout(self, new):
1988
self.overrideAttr(sys, 'stdout', new)
1990
def replace__terminal_size(self, new):
1991
self.overrideAttr(osutils, '_terminal_size', new)
1993
def set_fake_tty(self):
1995
class I_am_a_tty(object):
1999
self.replace_stdout(I_am_a_tty())
2001
def test_default_values(self):
2002
self.assertEqual(80, osutils.default_terminal_width)
2004
def test_defaults_to_BZR_COLUMNS(self):
2005
# BZR_COLUMNS is set by the test framework
2006
self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
2007
self.overrideEnv('BZR_COLUMNS', '12')
2008
self.assertEqual(12, osutils.terminal_width())
2010
def test_BZR_COLUMNS_0_no_limit(self):
2011
self.overrideEnv('BZR_COLUMNS', '0')
2012
self.assertEqual(None, osutils.terminal_width())
2014
def test_falls_back_to_COLUMNS(self):
2015
self.overrideEnv('BZR_COLUMNS', None)
2016
self.assertNotEqual('42', os.environ['COLUMNS'])
2018
self.overrideEnv('COLUMNS', '42')
2019
self.assertEqual(42, osutils.terminal_width())
2021
def test_tty_default_without_columns(self):
2022
self.overrideEnv('BZR_COLUMNS', None)
2023
self.overrideEnv('COLUMNS', None)
2025
def terminal_size(w, h):
2029
# We need to override the osutils definition as it depends on the
2030
# running environment that we can't control (PQM running without a
2031
# controlling terminal is one example).
2032
self.replace__terminal_size(terminal_size)
2033
self.assertEqual(42, osutils.terminal_width())
2035
def test_non_tty_default_without_columns(self):
2036
self.overrideEnv('BZR_COLUMNS', None)
2037
self.overrideEnv('COLUMNS', None)
2038
self.replace_stdout(None)
2039
self.assertEqual(None, osutils.terminal_width())
2041
def test_no_TIOCGWINSZ(self):
2042
self.requireFeature(term_ios_feature)
2043
termios = term_ios_feature.module
2044
# bug 63539 is about a termios without TIOCGWINSZ attribute
2046
orig = termios.TIOCGWINSZ
2047
except AttributeError:
2048
# We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
2051
self.overrideAttr(termios, 'TIOCGWINSZ')
2052
del termios.TIOCGWINSZ
2053
self.overrideEnv('BZR_COLUMNS', None)
2054
self.overrideEnv('COLUMNS', None)
2055
# Whatever the result is, if we don't raise an exception, it's ok.
2056
osutils.terminal_width()
2058
class TestCreationOps(tests.TestCaseInTempDir):
2059
_test_needs_features = [features.chown_feature]
2062
tests.TestCaseInTempDir.setUp(self)
2063
self.overrideAttr(os, 'chown', self._dummy_chown)
2065
# params set by call to _dummy_chown
2066
self.path = self.uid = self.gid = None
2068
def _dummy_chown(self, path, uid, gid):
2069
self.path, self.uid, self.gid = path, uid, gid
2071
def test_copy_ownership_from_path(self):
2072
"""copy_ownership_from_path test with specified src."""
2074
f = open('test_file', 'wt')
2075
osutils.copy_ownership_from_path('test_file', ownsrc)
2078
self.assertEquals(self.path, 'test_file')
2079
self.assertEquals(self.uid, s.st_uid)
2080
self.assertEquals(self.gid, s.st_gid)
2082
def test_copy_ownership_nonesrc(self):
2083
"""copy_ownership_from_path test with src=None."""
2084
f = open('test_file', 'wt')
2085
# should use parent dir for permissions
2086
osutils.copy_ownership_from_path('test_file')
2089
self.assertEquals(self.path, 'test_file')
2090
self.assertEquals(self.uid, s.st_uid)
2091
self.assertEquals(self.gid, s.st_gid)
2093
class TestGetuserUnicode(tests.TestCase):
2095
def test_ascii_user(self):
2096
self.overrideEnv('LOGNAME', 'jrandom')
2097
self.assertEqual(u'jrandom', osutils.getuser_unicode())
2099
def test_unicode_user(self):
2100
ue = osutils.get_user_encoding()
2101
uni_val, env_val = tests.probe_unicode_in_user_encoding()
2103
raise tests.TestSkipped(
2104
'Cannot find a unicode character that works in encoding %s'
2105
% (osutils.get_user_encoding(),))
2106
uni_username = u'jrandom' + uni_val
2107
encoded_username = uni_username.encode(ue)
2108
self.overrideEnv('LOGNAME', encoded_username)
2109
self.assertEqual(uni_username, osutils.getuser_unicode())
2110
self.overrideEnv('LOGNAME', u'jrandom\xb6'.encode(ue))
2111
self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
2113
class TestBackupNames(tests.TestCase):
2116
super(TestBackupNames, self).setUp()
2119
def backup_exists(self, name):
2120
return name in self.backups
2122
def available_backup_name(self, name):
2123
backup_name = osutils.available_backup_name(name, self.backup_exists)
2124
self.backups.append(backup_name)
2127
def assertBackupName(self, expected, name):
2128
self.assertEqual(expected, self.available_backup_name(name))
2130
def test_empty(self):
2131
self.assertBackupName('file.~1~', 'file')
2133
def test_existing(self):
2134
self.available_backup_name('file')
2135
self.available_backup_name('file')
2136
self.assertBackupName('file.~3~', 'file')
2137
# Empty slots are found, this is not a strict requirement and may be
2138
# revisited if we test against all implementations.
2139
self.backups.remove('file.~2~')
2140
self.assertBackupName('file.~2~', 'file')
2143
class TestFindExecutableInPath(tests.TestCase):
2145
def test_windows(self):
2146
if sys.platform != 'win32':
2147
raise tests.TestSkipped('test requires win32')
2148
self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
2150
osutils.find_executable_on_path('explorer.exe') is not None)
2152
osutils.find_executable_on_path('EXPLORER.EXE') is not None)
2154
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2155
self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
2157
def test_other(self):
2158
if sys.platform == 'win32':
2159
raise tests.TestSkipped('test requires non-win32')
2160
self.assertTrue(osutils.find_executable_on_path('sh') is not None)
2162
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
1037
self.failIf('BZR_TEST_ENV_VAR' in os.environ)
1040
class TestLocalTimeOffset(TestCase):
1042
def test_local_time_offset(self):
1043
"""Test that local_time_offset() returns a sane value."""
1044
offset = osutils.local_time_offset()
1045
self.assertTrue(isinstance(offset, int))
1046
# Test that the offset is no more than a eighteen hours in
1048
# Time zone handling is system specific, so it is difficult to
1049
# do more specific tests, but a value outside of this range is
1051
eighteen_hours = 18 * 3600
1052
self.assertTrue(-eighteen_hours < offset < eighteen_hours)
1054
def test_local_time_offset_with_timestamp(self):
1055
"""Test that local_time_offset() works with a timestamp."""
1056
offset = osutils.local_time_offset(1000000000.1234567)
1057
self.assertTrue(isinstance(offset, int))
1058
eighteen_hours = 18 * 3600
1059
self.assertTrue(-eighteen_hours < offset < eighteen_hours)
1062
class TestShaFileByName(TestCaseInTempDir):
1064
def test_sha_empty(self):
1065
self.build_tree_contents([('foo', '')])
1066
expected_sha = osutils.sha_string('')
1067
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1069
def test_sha_mixed_endings(self):
1070
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1071
self.build_tree_contents([('foo', text)])
1072
expected_sha = osutils.sha_string(text)
1073
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
added
removed
bzrlib/tests/test_osutils.py
