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
29
26
from bzrlib import (
31
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
32
from bzrlib.osutils import (
34
is_inside_or_parent_of_any,
38
37
from bzrlib.tests import (
43
from bzrlib.tests.scenarios import load_tests_apply_scenarios
46
class _UTF8DirReaderFeature(features.Feature):
50
from bzrlib import _readdir_pyx
51
self.reader = _readdir_pyx.UTF8DirReader
56
def feature_name(self):
57
return 'bzrlib._readdir_pyx'
59
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
61
term_ios_feature = features.ModuleAvailableFeature('termios')
64
def _already_unicode(s):
68
def _utf8_to_unicode(s):
69
return s.decode('UTF-8')
72
def dir_reader_scenarios():
73
# For each dir reader we define:
75
# - native_to_unicode: a function converting the native_abspath as returned
76
# by DirReader.read_dir to its unicode representation
78
# UnicodeDirReader is the fallback, it should be tested on all platforms.
79
scenarios = [('unicode',
80
dict(_dir_reader_class=osutils.UnicodeDirReader,
81
_native_to_unicode=_already_unicode))]
82
# Some DirReaders are platform specific and even there they may not be
84
if UTF8DirReaderFeature.available():
85
from bzrlib import _readdir_pyx
86
scenarios.append(('utf8',
87
dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
88
_native_to_unicode=_utf8_to_unicode)))
90
if test__walkdirs_win32.win32_readdir_feature.available():
92
from bzrlib import _walkdirs_win32
95
dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
96
_native_to_unicode=_already_unicode)))
102
load_tests = load_tests_apply_scenarios
105
class TestContainsWhitespace(tests.TestCase):
38
probe_unicode_in_user_encoding,
47
class TestOSUtils(TestCaseInTempDir):
107
49
def test_contains_whitespace(self):
108
self.assertTrue(osutils.contains_whitespace(u' '))
109
self.assertTrue(osutils.contains_whitespace(u'hello there'))
110
self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
111
self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
112
self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
113
self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
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'))
115
57
# \xa0 is "Non-breaking-space" which on some python locales thinks it
116
58
# is whitespace, but we do not.
117
self.assertFalse(osutils.contains_whitespace(u''))
118
self.assertFalse(osutils.contains_whitespace(u'hellothere'))
119
self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
122
class TestRename(tests.TestCaseInTempDir):
124
def create_file(self, filename, content):
125
f = open(filename, 'wb')
131
def _fancy_rename(self, a, b):
132
osutils.fancy_rename(a, b, rename_func=os.rename,
133
unlink_func=os.unlink)
59
self.failIf(osutils.contains_whitespace(u''))
60
self.failIf(osutils.contains_whitespace(u'hellothere'))
61
self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
135
63
def test_fancy_rename(self):
136
64
# This should work everywhere
137
self.create_file('a', 'something in a\n')
138
self._fancy_rename('a', 'b')
139
self.assertPathDoesNotExist('a')
140
self.assertPathExists('b')
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')
141
74
self.check_file_contents('b', 'something in a\n')
143
self.create_file('a', 'new something in a\n')
144
self._fancy_rename('b', 'a')
76
open('a', 'wb').write('new something in a\n')
146
79
self.check_file_contents('a', 'something in a\n')
148
def test_fancy_rename_fails_source_missing(self):
149
# An exception should be raised, and the target should be left in place
150
self.create_file('target', 'data in target\n')
151
self.assertRaises((IOError, OSError), self._fancy_rename,
152
'missingsource', 'target')
153
self.assertPathExists('target')
154
self.check_file_contents('target', 'data in target\n')
156
def test_fancy_rename_fails_if_source_and_target_missing(self):
157
self.assertRaises((IOError, OSError), self._fancy_rename,
158
'missingsource', 'missingtarget')
160
81
def test_rename(self):
161
82
# Rename should be semi-atomic on all platforms
162
self.create_file('a', 'something in a\n')
83
open('a', 'wb').write('something in a\n')
163
84
osutils.rename('a', 'b')
164
self.assertPathDoesNotExist('a')
165
self.assertPathExists('b')
85
self.failIfExists('a')
86
self.failUnlessExists('b')
166
87
self.check_file_contents('b', 'something in a\n')
168
self.create_file('a', 'new something in a\n')
89
open('a', 'wb').write('new something in a\n')
169
90
osutils.rename('b', 'a')
171
92
self.check_file_contents('a', 'something in a\n')
530
312
osutils.make_readonly('dangling')
531
313
osutils.make_writable('dangling')
533
def test_host_os_dereferences_symlinks(self):
534
osutils.host_os_dereferences_symlinks()
537
class TestCanonicalRelPath(tests.TestCaseInTempDir):
539
_test_needs_features = [features.CaseInsCasePresFilenameFeature]
541
def test_canonical_relpath_simple(self):
542
f = file('MixedCaseName', 'w')
544
actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
545
self.assertEqual('work/MixedCaseName', actual)
547
def test_canonical_relpath_missing_tail(self):
548
os.mkdir('MixedCaseParent')
549
actual = osutils.canonical_relpath(self.test_base_dir,
550
'mixedcaseparent/nochild')
551
self.assertEqual('work/MixedCaseParent/nochild', actual)
554
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
556
def assertRelpath(self, expected, base, path):
557
actual = osutils._cicp_canonical_relpath(base, path)
558
self.assertEqual(expected, actual)
560
def test_simple(self):
561
self.build_tree(['MixedCaseName'])
562
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
563
self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
565
def test_subdir_missing_tail(self):
566
self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
567
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
568
self.assertRelpath('MixedCaseParent/a_child', base,
569
'MixedCaseParent/a_child')
570
self.assertRelpath('MixedCaseParent/a_child', base,
571
'MixedCaseParent/A_Child')
572
self.assertRelpath('MixedCaseParent/not_child', base,
573
'MixedCaseParent/not_child')
575
def test_at_root_slash(self):
576
# We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
578
if osutils.MIN_ABS_PATHLENGTH > 1:
579
raise tests.TestSkipped('relpath requires %d chars'
580
% osutils.MIN_ABS_PATHLENGTH)
581
self.assertRelpath('foo', '/', '/foo')
583
def test_at_root_drive(self):
584
if sys.platform != 'win32':
585
raise tests.TestNotApplicable('we can only test drive-letter relative'
586
' paths on Windows where we have drive'
589
# The specific issue is that when at the root of a drive, 'abspath'
590
# returns "C:/" or just "/". However, the code assumes that abspath
591
# always returns something like "C:/foo" or "/foo" (no trailing slash).
592
self.assertRelpath('foo', 'C:/', 'C:/foo')
593
self.assertRelpath('foo', 'X:/', 'X:/foo')
594
self.assertRelpath('foo', 'X:/', 'X://foo')
597
class TestPumpFile(tests.TestCase):
598
"""Test pumpfile method."""
601
super(TestPumpFile, self).setUp()
602
# create a test datablock
603
self.block_size = 512
604
pattern = '0123456789ABCDEF'
605
self.test_data = pattern * (3 * self.block_size / len(pattern))
606
self.test_data_len = len(self.test_data)
608
def test_bracket_block_size(self):
609
"""Read data in blocks with the requested read size bracketing the
611
# make sure test data is larger than max read size
612
self.assertTrue(self.test_data_len > self.block_size)
614
from_file = file_utils.FakeReadFile(self.test_data)
617
# read (max / 2) bytes and verify read size wasn't affected
618
num_bytes_to_read = self.block_size / 2
619
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
620
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
621
self.assertEqual(from_file.get_read_count(), 1)
623
# read (max) bytes and verify read size wasn't affected
624
num_bytes_to_read = self.block_size
625
from_file.reset_read_count()
626
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
627
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
628
self.assertEqual(from_file.get_read_count(), 1)
630
# read (max + 1) bytes and verify read size was limited
631
num_bytes_to_read = self.block_size + 1
632
from_file.reset_read_count()
633
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
634
self.assertEqual(from_file.get_max_read_size(), self.block_size)
635
self.assertEqual(from_file.get_read_count(), 2)
637
# finish reading the rest of the data
638
num_bytes_to_read = self.test_data_len - to_file.tell()
639
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
641
# report error if the data wasn't equal (we only report the size due
642
# to the length of the data)
643
response_data = to_file.getvalue()
644
if response_data != self.test_data:
645
message = "Data not equal. Expected %d bytes, received %d."
646
self.fail(message % (len(response_data), self.test_data_len))
648
def test_specified_size(self):
649
"""Request a transfer larger than the maximum block size and verify
650
that the maximum read doesn't exceed the block_size."""
651
# make sure test data is larger than max read size
652
self.assertTrue(self.test_data_len > self.block_size)
654
# retrieve data in blocks
655
from_file = file_utils.FakeReadFile(self.test_data)
657
osutils.pumpfile(from_file, to_file, self.test_data_len,
660
# verify read size was equal to the maximum read size
661
self.assertTrue(from_file.get_max_read_size() > 0)
662
self.assertEqual(from_file.get_max_read_size(), self.block_size)
663
self.assertEqual(from_file.get_read_count(), 3)
665
# report error if the data wasn't equal (we only report the size due
666
# to the length of the data)
667
response_data = to_file.getvalue()
668
if response_data != self.test_data:
669
message = "Data not equal. Expected %d bytes, received %d."
670
self.fail(message % (len(response_data), self.test_data_len))
672
def test_to_eof(self):
673
"""Read to end-of-file and verify that the reads are not larger than
674
the maximum read size."""
675
# make sure test data is larger than max read size
676
self.assertTrue(self.test_data_len > self.block_size)
678
# retrieve data to EOF
679
from_file = file_utils.FakeReadFile(self.test_data)
681
osutils.pumpfile(from_file, to_file, -1, self.block_size)
683
# verify read size was equal to the maximum read size
684
self.assertEqual(from_file.get_max_read_size(), self.block_size)
685
self.assertEqual(from_file.get_read_count(), 4)
687
# report error if the data wasn't equal (we only report the size due
688
# to the length of the data)
689
response_data = to_file.getvalue()
690
if response_data != self.test_data:
691
message = "Data not equal. Expected %d bytes, received %d."
692
self.fail(message % (len(response_data), self.test_data_len))
694
def test_defaults(self):
695
"""Verifies that the default arguments will read to EOF -- this
696
test verifies that any existing usages of pumpfile will not be broken
697
with this new version."""
698
# retrieve data using default (old) pumpfile method
699
from_file = file_utils.FakeReadFile(self.test_data)
701
osutils.pumpfile(from_file, to_file)
703
# report error if the data wasn't equal (we only report the size due
704
# to the length of the data)
705
response_data = to_file.getvalue()
706
if response_data != self.test_data:
707
message = "Data not equal. Expected %d bytes, received %d."
708
self.fail(message % (len(response_data), self.test_data_len))
710
def test_report_activity(self):
712
def log_activity(length, direction):
713
activity.append((length, direction))
714
from_file = StringIO(self.test_data)
716
osutils.pumpfile(from_file, to_file, buff_size=500,
717
report_activity=log_activity, direction='read')
718
self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
719
(36, 'read')], activity)
721
from_file = StringIO(self.test_data)
724
osutils.pumpfile(from_file, to_file, buff_size=500,
725
report_activity=log_activity, direction='write')
726
self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
727
(36, 'write')], activity)
729
# And with a limited amount of data
730
from_file = StringIO(self.test_data)
733
osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
734
report_activity=log_activity, direction='read')
735
self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
739
class TestPumpStringFile(tests.TestCase):
741
def test_empty(self):
743
osutils.pump_string_file("", output)
744
self.assertEqual("", output.getvalue())
746
def test_more_than_segment_size(self):
748
osutils.pump_string_file("123456789", output, 2)
749
self.assertEqual("123456789", output.getvalue())
751
def test_segment_size(self):
753
osutils.pump_string_file("12", output, 2)
754
self.assertEqual("12", output.getvalue())
756
def test_segment_size_multiple(self):
758
osutils.pump_string_file("1234", output, 2)
759
self.assertEqual("1234", output.getvalue())
762
class TestRelpath(tests.TestCase):
764
def test_simple_relpath(self):
765
cwd = osutils.getcwd()
766
subdir = cwd + '/subdir'
767
self.assertEqual('subdir', osutils.relpath(cwd, subdir))
769
def test_deep_relpath(self):
770
cwd = osutils.getcwd()
771
subdir = cwd + '/sub/subsubdir'
772
self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
774
def test_not_relative(self):
775
self.assertRaises(errors.PathNotChild,
776
osutils.relpath, 'C:/path', 'H:/path')
777
self.assertRaises(errors.PathNotChild,
778
osutils.relpath, 'C:/', 'H:/path')
781
class TestSafeUnicode(tests.TestCase):
315
def test_kind_marker(self):
316
self.assertEqual("", osutils.kind_marker("file"))
317
self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
318
self.assertEqual("@", osutils.kind_marker("symlink"))
319
self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
322
class TestSafeUnicode(TestCase):
783
324
def test_from_ascii_string(self):
784
325
self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
1450
808
result.append((dirdetail, new_dirblock))
1451
809
self.assertEqual(expected_dirblocks, result)
1453
def test__walkdirs_utf8_with_unicode_fs(self):
1454
"""UnicodeDirReader should be a safe fallback everywhere
811
def test_unicode__walkdirs_unicode_to_utf8(self):
812
"""walkdirs_unicode_to_utf8 should be a safe fallback everywhere
1456
814
The abspath portion should be in unicode
1458
self.requireFeature(features.UnicodeFilenameFeature)
1459
# Use the unicode reader. TODO: split into driver-and-driven unit
1461
self._save_platform_info()
1462
osutils._selected_dir_reader = osutils.UnicodeDirReader()
1463
name0u = u'0file-\xb6'
1464
name1u = u'1dir-\u062c\u0648'
1465
name2u = u'2file-\u0633'
1469
name1u + '/' + name0u,
1470
name1u + '/' + name1u + '/',
1473
self.build_tree(tree)
1474
name0 = name0u.encode('utf8')
1475
name1 = name1u.encode('utf8')
1476
name2 = name2u.encode('utf8')
1478
# All of the abspaths should be in unicode, all of the relative paths
1480
expected_dirblocks = [
1482
[(name0, name0, 'file', './' + name0u),
1483
(name1, name1, 'directory', './' + name1u),
1484
(name2, name2, 'file', './' + name2u),
1487
((name1, './' + name1u),
1488
[(name1 + '/' + name0, name0, 'file', './' + name1u
1490
(name1 + '/' + name1, name1, 'directory', './' + name1u
1494
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1499
result = list(osutils._walkdirs_utf8('.'))
1500
self._filter_out_stat(result)
1501
self.assertEqual(expected_dirblocks, result)
1503
def test__walkdirs_utf8_win32readdir(self):
1504
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1505
self.requireFeature(features.UnicodeFilenameFeature)
1506
from bzrlib._walkdirs_win32 import Win32ReadDir
1507
self._save_platform_info()
1508
osutils._selected_dir_reader = Win32ReadDir()
1509
name0u = u'0file-\xb6'
1510
name1u = u'1dir-\u062c\u0648'
1511
name2u = u'2file-\u0633'
1515
name1u + '/' + name0u,
1516
name1u + '/' + name1u + '/',
1519
self.build_tree(tree)
1520
name0 = name0u.encode('utf8')
1521
name1 = name1u.encode('utf8')
1522
name2 = name2u.encode('utf8')
1524
# All of the abspaths should be in unicode, all of the relative paths
1526
expected_dirblocks = [
1528
[(name0, name0, 'file', './' + name0u),
1529
(name1, name1, 'directory', './' + name1u),
1530
(name2, name2, 'file', './' + name2u),
1533
((name1, './' + name1u),
1534
[(name1 + '/' + name0, name0, 'file', './' + name1u
1536
(name1 + '/' + name1, name1, 'directory', './' + name1u
1540
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1545
result = list(osutils._walkdirs_utf8(u'.'))
1546
self._filter_out_stat(result)
1547
self.assertEqual(expected_dirblocks, result)
1549
def assertStatIsCorrect(self, path, win32stat):
1550
os_stat = os.stat(path)
1551
self.assertEqual(os_stat.st_size, win32stat.st_size)
1552
self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
1553
self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
1554
self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
1555
self.assertEqual(os_stat.st_dev, win32stat.st_dev)
1556
self.assertEqual(os_stat.st_ino, win32stat.st_ino)
1557
self.assertEqual(os_stat.st_mode, win32stat.st_mode)
1559
def test__walkdirs_utf_win32_find_file_stat_file(self):
1560
"""make sure our Stat values are valid"""
1561
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1562
self.requireFeature(features.UnicodeFilenameFeature)
1563
from bzrlib._walkdirs_win32 import Win32ReadDir
1564
name0u = u'0file-\xb6'
1565
name0 = name0u.encode('utf8')
1566
self.build_tree([name0u])
1567
# I hate to sleep() here, but I'm trying to make the ctime different
1570
f = open(name0u, 'ab')
816
name0u = u'0file-\xb6'
817
name1u = u'1dir-\u062c\u0648'
818
name2u = u'2file-\u0633'
822
name1u + '/' + name0u,
823
name1u + '/' + name1u + '/',
1572
f.write('just a small update')
1576
result = Win32ReadDir().read_dir('', u'.')
1578
self.assertEqual((name0, name0, 'file'), entry[:3])
1579
self.assertEqual(u'./' + name0u, entry[4])
1580
self.assertStatIsCorrect(entry[4], entry[3])
1581
self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
1583
def test__walkdirs_utf_win32_find_file_stat_directory(self):
1584
"""make sure our Stat values are valid"""
1585
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1586
self.requireFeature(features.UnicodeFilenameFeature)
1587
from bzrlib._walkdirs_win32 import Win32ReadDir
1588
name0u = u'0dir-\u062c\u0648'
827
self.build_tree(tree)
829
raise TestSkipped('Could not represent Unicode chars'
830
' in current encoding.')
1589
831
name0 = name0u.encode('utf8')
1590
self.build_tree([name0u + '/'])
832
name1 = name1u.encode('utf8')
833
name2 = name2u.encode('utf8')
1592
result = Win32ReadDir().read_dir('', u'.')
1594
self.assertEqual((name0, name0, 'directory'), entry[:3])
1595
self.assertEqual(u'./' + name0u, entry[4])
1596
self.assertStatIsCorrect(entry[4], entry[3])
835
# All of the abspaths should be in unicode, all of the relative paths
837
expected_dirblocks = [
839
[(name0, name0, 'file', './' + name0u),
840
(name1, name1, 'directory', './' + name1u),
841
(name2, name2, 'file', './' + name2u),
844
((name1, './' + name1u),
845
[(name1 + '/' + name0, name0, 'file', './' + name1u
847
(name1 + '/' + name1, name1, 'directory', './' + name1u
851
((name1 + '/' + name1, './' + name1u + '/' + name1u),
856
result = list(osutils._walkdirs_unicode_to_utf8('.'))
857
self._filter_out_stat(result)
858
self.assertEqual(expected_dirblocks, result)
1598
860
def assertPathCompare(self, path_less, path_greater):
1599
861
"""check that path_less and path_greater compare correctly."""
1772
1038
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1773
1039
self.assertEqual('foo', old)
1774
1040
self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1775
self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1778
class TestSizeShaFile(tests.TestCaseInTempDir):
1780
def test_sha_empty(self):
1781
self.build_tree_contents([('foo', '')])
1782
expected_sha = osutils.sha_string('')
1784
self.addCleanup(f.close)
1785
size, sha = osutils.size_sha_file(f)
1786
self.assertEqual(0, size)
1787
self.assertEqual(expected_sha, sha)
1789
def test_sha_mixed_endings(self):
1790
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1791
self.build_tree_contents([('foo', text)])
1792
expected_sha = osutils.sha_string(text)
1793
f = open('foo', 'rb')
1794
self.addCleanup(f.close)
1795
size, sha = osutils.size_sha_file(f)
1796
self.assertEqual(38, size)
1797
self.assertEqual(expected_sha, sha)
1800
class TestShaFileByName(tests.TestCaseInTempDir):
1802
def test_sha_empty(self):
1803
self.build_tree_contents([('foo', '')])
1804
expected_sha = osutils.sha_string('')
1805
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1807
def test_sha_mixed_endings(self):
1808
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1809
self.build_tree_contents([('foo', text)])
1810
expected_sha = osutils.sha_string(text)
1811
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1814
class TestResourceLoading(tests.TestCaseInTempDir):
1041
self.failIf('BZR_TEST_ENV_VAR' in os.environ)
1044
class TestLocalTimeOffset(TestCase):
1046
def test_local_time_offset(self):
1047
"""Test that local_time_offset() returns a sane value."""
1048
offset = osutils.local_time_offset()
1049
self.assertTrue(isinstance(offset, int))
1050
# Test that the offset is no more than a eighteen hours in
1052
# Time zone handling is system specific, so it is difficult to
1053
# do more specific tests, but a value outside of this range is
1055
eighteen_hours = 18 * 3600
1056
self.assertTrue(-eighteen_hours < offset < eighteen_hours)
1058
def test_local_time_offset_with_timestamp(self):
1059
"""Test that local_time_offset() works with a timestamp."""
1060
offset = osutils.local_time_offset(1000000000.1234567)
1061
self.assertTrue(isinstance(offset, int))
1062
eighteen_hours = 18 * 3600
1063
self.assertTrue(-eighteen_hours < offset < eighteen_hours)
1066
class TestShaFileByName(TestCaseInTempDir):
1068
def test_sha_empty(self):
1069
self.build_tree_contents([('foo', '')])
1070
expected_sha = osutils.sha_string('')
1071
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1073
def test_sha_mixed_endings(self):
1074
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1075
self.build_tree_contents([('foo', text)])
1076
expected_sha = osutils.sha_string(text)
1077
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1081
r'''# Copyright (C) 2005, 2006 Canonical Ltd
1083
# This program is free software; you can redistribute it and/or modify
1084
# it under the terms of the GNU General Public License as published by
1085
# the Free Software Foundation; either version 2 of the License, or
1086
# (at your option) any later version.
1088
# This program is distributed in the hope that it will be useful,
1089
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1090
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1091
# GNU General Public License for more details.
1093
# You should have received a copy of the GNU General Public License
1094
# along with this program; if not, write to the Free Software
1095
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1098
# NOTE: If update these, please also update the help for global-options in
1099
# bzrlib/help_topics/__init__.py
1102
"""Set of flags that enable different debug behaviour.
1104
These are set with eg ``-Dlock`` on the bzr command line.
1108
* auth - show authentication sections used
1109
* error - show stack traces for all top level exceptions
1110
* evil - capture call sites that do expensive or badly-scaling operations.
1111
* fetch - trace history copying between repositories
1112
* graph - trace graph traversal information
1113
* hashcache - log every time a working file is read to determine its hash
1114
* hooks - trace hook execution
1115
* hpss - trace smart protocol requests and responses
1116
* http - trace http connections, requests and responses
1117
* index - trace major index operations
1118
* knit - trace knit operations
1119
* lock - trace when lockdir locks are taken or released
1120
* merge - emit information for debugging merges
1121
* pack - emit information about pack operations
1127
class TestResourceLoading(TestCaseInTempDir):
1816
1129
def test_resource_string(self):
1817
1130
# test resource in bzrlib
1818
1131
text = osutils.resource_string('bzrlib', 'debug.py')
1819
self.assertContainsRe(text, "debug_flags = set()")
1132
self.assertEquals(_debug_text, text)
1820
1133
# test resource under bzrlib
1821
1134
text = osutils.resource_string('bzrlib.ui', 'text.py')
1822
1135
self.assertContainsRe(text, "class TextUIFactory")
1826
1139
# test unknown resource
1827
1140
self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
1830
class TestReCompile(tests.TestCase):
1832
def _deprecated_re_compile_checked(self, *args, **kwargs):
1833
return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1834
osutils.re_compile_checked, *args, **kwargs)
1836
def test_re_compile_checked(self):
1837
r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1838
self.assertTrue(r.match('aaaa'))
1839
self.assertTrue(r.match('aAaA'))
1841
def test_re_compile_checked_error(self):
1842
# like https://bugs.launchpad.net/bzr/+bug/251352
1844
# Due to possible test isolation error, re.compile is not lazy at
1845
# this point. We re-install lazy compile.
1846
lazy_regex.install_lazy_compile()
1847
err = self.assertRaises(
1848
errors.BzrCommandError,
1849
self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1851
'Invalid regular expression in test case: '
1852
'"*" nothing to repeat',
1856
class TestDirReader(tests.TestCaseInTempDir):
1858
scenarios = dir_reader_scenarios()
1861
_dir_reader_class = None
1862
_native_to_unicode = None
1865
super(TestDirReader, self).setUp()
1866
self.overrideAttr(osutils,
1867
'_selected_dir_reader', self._dir_reader_class())
1869
def _get_ascii_tree(self):
1877
expected_dirblocks = [
1879
[('0file', '0file', 'file'),
1880
('1dir', '1dir', 'directory'),
1881
('2file', '2file', 'file'),
1884
(('1dir', './1dir'),
1885
[('1dir/0file', '0file', 'file'),
1886
('1dir/1dir', '1dir', 'directory'),
1889
(('1dir/1dir', './1dir/1dir'),
1894
return tree, expected_dirblocks
1896
def test_walk_cur_dir(self):
1897
tree, expected_dirblocks = self._get_ascii_tree()
1898
self.build_tree(tree)
1899
result = list(osutils._walkdirs_utf8('.'))
1900
# Filter out stat and abspath
1901
self.assertEqual(expected_dirblocks,
1902
[(dirinfo, [line[0:3] for line in block])
1903
for dirinfo, block in result])
1905
def test_walk_sub_dir(self):
1906
tree, expected_dirblocks = self._get_ascii_tree()
1907
self.build_tree(tree)
1908
# you can search a subdir only, with a supplied prefix.
1909
result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
1910
# Filter out stat and abspath
1911
self.assertEqual(expected_dirblocks[1:],
1912
[(dirinfo, [line[0:3] for line in block])
1913
for dirinfo, block in result])
1915
def _get_unicode_tree(self):
1916
name0u = u'0file-\xb6'
1917
name1u = u'1dir-\u062c\u0648'
1918
name2u = u'2file-\u0633'
1922
name1u + '/' + name0u,
1923
name1u + '/' + name1u + '/',
1926
name0 = name0u.encode('UTF-8')
1927
name1 = name1u.encode('UTF-8')
1928
name2 = name2u.encode('UTF-8')
1929
expected_dirblocks = [
1931
[(name0, name0, 'file', './' + name0u),
1932
(name1, name1, 'directory', './' + name1u),
1933
(name2, name2, 'file', './' + name2u),
1936
((name1, './' + name1u),
1937
[(name1 + '/' + name0, name0, 'file', './' + name1u
1939
(name1 + '/' + name1, name1, 'directory', './' + name1u
1943
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1948
return tree, expected_dirblocks
1950
def _filter_out(self, raw_dirblocks):
1951
"""Filter out a walkdirs_utf8 result.
1953
stat field is removed, all native paths are converted to unicode
1955
filtered_dirblocks = []
1956
for dirinfo, block in raw_dirblocks:
1957
dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
1960
details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
1961
filtered_dirblocks.append((dirinfo, details))
1962
return filtered_dirblocks
1964
def test_walk_unicode_tree(self):
1965
self.requireFeature(features.UnicodeFilenameFeature)
1966
tree, expected_dirblocks = self._get_unicode_tree()
1967
self.build_tree(tree)
1968
result = list(osutils._walkdirs_utf8('.'))
1969
self.assertEqual(expected_dirblocks, self._filter_out(result))
1971
def test_symlink(self):
1972
self.requireFeature(features.SymlinkFeature)
1973
self.requireFeature(features.UnicodeFilenameFeature)
1974
target = u'target\N{Euro Sign}'
1975
link_name = u'l\N{Euro Sign}nk'
1976
os.symlink(target, link_name)
1977
target_utf8 = target.encode('UTF-8')
1978
link_name_utf8 = link_name.encode('UTF-8')
1979
expected_dirblocks = [
1981
[(link_name_utf8, link_name_utf8,
1982
'symlink', './' + link_name),],
1984
result = list(osutils._walkdirs_utf8('.'))
1985
self.assertEqual(expected_dirblocks, self._filter_out(result))
1988
class TestReadLink(tests.TestCaseInTempDir):
1989
"""Exposes os.readlink() problems and the osutils solution.
1991
The only guarantee offered by os.readlink(), starting with 2.6, is that a
1992
unicode string will be returned if a unicode string is passed.
1994
But prior python versions failed to properly encode the passed unicode
1997
_test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
2000
super(tests.TestCaseInTempDir, self).setUp()
2001
self.link = u'l\N{Euro Sign}ink'
2002
self.target = u'targe\N{Euro Sign}t'
2003
os.symlink(self.target, self.link)
2005
def test_os_readlink_link_encoding(self):
2006
self.assertEqual(self.target, os.readlink(self.link))
2008
def test_os_readlink_link_decoding(self):
2009
self.assertEqual(self.target.encode(osutils._fs_enc),
2010
os.readlink(self.link.encode(osutils._fs_enc)))
2013
class TestConcurrency(tests.TestCase):
2016
super(TestConcurrency, self).setUp()
2017
self.overrideAttr(osutils, '_cached_local_concurrency')
2019
def test_local_concurrency(self):
2020
concurrency = osutils.local_concurrency()
2021
self.assertIsInstance(concurrency, int)
2023
def test_local_concurrency_environment_variable(self):
2024
self.overrideEnv('BZR_CONCURRENCY', '2')
2025
self.assertEqual(2, osutils.local_concurrency(use_cache=False))
2026
self.overrideEnv('BZR_CONCURRENCY', '3')
2027
self.assertEqual(3, osutils.local_concurrency(use_cache=False))
2028
self.overrideEnv('BZR_CONCURRENCY', 'foo')
2029
self.assertEqual(1, osutils.local_concurrency(use_cache=False))
2031
def test_option_concurrency(self):
2032
self.overrideEnv('BZR_CONCURRENCY', '1')
2033
self.run_bzr('rocks --concurrency 42')
2034
# Command line overrides environment variable
2035
self.assertEqual('42', os.environ['BZR_CONCURRENCY'])
2036
self.assertEqual(42, osutils.local_concurrency(use_cache=False))
2039
class TestFailedToLoadExtension(tests.TestCase):
2041
def _try_loading(self):
2043
import bzrlib._fictional_extension_py
2044
except ImportError, e:
2045
osutils.failed_to_load_extension(e)
2049
super(TestFailedToLoadExtension, self).setUp()
2050
self.overrideAttr(osutils, '_extension_load_failures', [])
2052
def test_failure_to_load(self):
2054
self.assertLength(1, osutils._extension_load_failures)
2055
self.assertEqual(osutils._extension_load_failures[0],
2056
"No module named _fictional_extension_py")
2058
def test_report_extension_load_failures_no_warning(self):
2059
self.assertTrue(self._try_loading())
2060
warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
2061
# it used to give a Python warning; it no longer does
2062
self.assertLength(0, warnings)
2064
def test_report_extension_load_failures_message(self):
2066
trace.push_log_file(log)
2067
self.assertTrue(self._try_loading())
2068
osutils.report_extension_load_failures()
2069
self.assertContainsRe(
2071
r"bzr: warning: some compiled extensions could not be loaded; "
2072
"see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
2076
class TestTerminalWidth(tests.TestCase):
2079
super(TestTerminalWidth, self).setUp()
2080
self._orig_terminal_size_state = osutils._terminal_size_state
2081
self._orig_first_terminal_size = osutils._first_terminal_size
2082
self.addCleanup(self.restore_osutils_globals)
2083
osutils._terminal_size_state = 'no_data'
2084
osutils._first_terminal_size = None
2086
def restore_osutils_globals(self):
2087
osutils._terminal_size_state = self._orig_terminal_size_state
2088
osutils._first_terminal_size = self._orig_first_terminal_size
2090
def replace_stdout(self, new):
2091
self.overrideAttr(sys, 'stdout', new)
2093
def replace__terminal_size(self, new):
2094
self.overrideAttr(osutils, '_terminal_size', new)
2096
def set_fake_tty(self):
2098
class I_am_a_tty(object):
2102
self.replace_stdout(I_am_a_tty())
2104
def test_default_values(self):
2105
self.assertEqual(80, osutils.default_terminal_width)
2107
def test_defaults_to_BZR_COLUMNS(self):
2108
# BZR_COLUMNS is set by the test framework
2109
self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
2110
self.overrideEnv('BZR_COLUMNS', '12')
2111
self.assertEqual(12, osutils.terminal_width())
2113
def test_BZR_COLUMNS_0_no_limit(self):
2114
self.overrideEnv('BZR_COLUMNS', '0')
2115
self.assertEqual(None, osutils.terminal_width())
2117
def test_falls_back_to_COLUMNS(self):
2118
self.overrideEnv('BZR_COLUMNS', None)
2119
self.assertNotEqual('42', os.environ['COLUMNS'])
2121
self.overrideEnv('COLUMNS', '42')
2122
self.assertEqual(42, osutils.terminal_width())
2124
def test_tty_default_without_columns(self):
2125
self.overrideEnv('BZR_COLUMNS', None)
2126
self.overrideEnv('COLUMNS', None)
2128
def terminal_size(w, h):
2132
# We need to override the osutils definition as it depends on the
2133
# running environment that we can't control (PQM running without a
2134
# controlling terminal is one example).
2135
self.replace__terminal_size(terminal_size)
2136
self.assertEqual(42, osutils.terminal_width())
2138
def test_non_tty_default_without_columns(self):
2139
self.overrideEnv('BZR_COLUMNS', None)
2140
self.overrideEnv('COLUMNS', None)
2141
self.replace_stdout(None)
2142
self.assertEqual(None, osutils.terminal_width())
2144
def test_no_TIOCGWINSZ(self):
2145
self.requireFeature(term_ios_feature)
2146
termios = term_ios_feature.module
2147
# bug 63539 is about a termios without TIOCGWINSZ attribute
2149
orig = termios.TIOCGWINSZ
2150
except AttributeError:
2151
# We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
2154
self.overrideAttr(termios, 'TIOCGWINSZ')
2155
del termios.TIOCGWINSZ
2156
self.overrideEnv('BZR_COLUMNS', None)
2157
self.overrideEnv('COLUMNS', None)
2158
# Whatever the result is, if we don't raise an exception, it's ok.
2159
osutils.terminal_width()
2162
class TestCreationOps(tests.TestCaseInTempDir):
2163
_test_needs_features = [features.chown_feature]
2166
super(TestCreationOps, self).setUp()
2167
self.overrideAttr(os, 'chown', self._dummy_chown)
2169
# params set by call to _dummy_chown
2170
self.path = self.uid = self.gid = None
2172
def _dummy_chown(self, path, uid, gid):
2173
self.path, self.uid, self.gid = path, uid, gid
2175
def test_copy_ownership_from_path(self):
2176
"""copy_ownership_from_path test with specified src."""
2178
f = open('test_file', 'wt')
2179
osutils.copy_ownership_from_path('test_file', ownsrc)
2182
self.assertEqual(self.path, 'test_file')
2183
self.assertEqual(self.uid, s.st_uid)
2184
self.assertEqual(self.gid, s.st_gid)
2186
def test_copy_ownership_nonesrc(self):
2187
"""copy_ownership_from_path test with src=None."""
2188
f = open('test_file', 'wt')
2189
# should use parent dir for permissions
2190
osutils.copy_ownership_from_path('test_file')
2193
self.assertEqual(self.path, 'test_file')
2194
self.assertEqual(self.uid, s.st_uid)
2195
self.assertEqual(self.gid, s.st_gid)
2198
class TestPathFromEnviron(tests.TestCase):
2200
def test_is_unicode(self):
2201
self.overrideEnv('BZR_TEST_PATH', './anywhere at all/')
2202
path = osutils.path_from_environ('BZR_TEST_PATH')
2203
self.assertIsInstance(path, unicode)
2204
self.assertEqual(u'./anywhere at all/', path)
2206
def test_posix_path_env_ascii(self):
2207
self.overrideEnv('BZR_TEST_PATH', '/tmp')
2208
home = osutils._posix_path_from_environ('BZR_TEST_PATH')
2209
self.assertIsInstance(home, unicode)
2210
self.assertEqual(u'/tmp', home)
2212
def test_posix_path_env_unicode(self):
2213
self.requireFeature(features.ByteStringNamedFilesystem)
2214
self.overrideEnv('BZR_TEST_PATH', '/home/\xa7test')
2215
self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
2216
self.assertEqual(u'/home/\xa7test',
2217
osutils._posix_path_from_environ('BZR_TEST_PATH'))
2218
osutils._fs_enc = "iso8859-5"
2219
self.assertEqual(u'/home/\u0407test',
2220
osutils._posix_path_from_environ('BZR_TEST_PATH'))
2221
osutils._fs_enc = "utf-8"
2222
self.assertRaises(errors.BadFilenameEncoding,
2223
osutils._posix_path_from_environ, 'BZR_TEST_PATH')
2226
class TestGetHomeDir(tests.TestCase):
2228
def test_is_unicode(self):
2229
home = osutils._get_home_dir()
2230
self.assertIsInstance(home, unicode)
2232
def test_posix_homeless(self):
2233
self.overrideEnv('HOME', None)
2234
home = osutils._get_home_dir()
2235
self.assertIsInstance(home, unicode)
2237
def test_posix_home_ascii(self):
2238
self.overrideEnv('HOME', '/home/test')
2239
home = osutils._posix_get_home_dir()
2240
self.assertIsInstance(home, unicode)
2241
self.assertEqual(u'/home/test', home)
2243
def test_posix_home_unicode(self):
2244
self.requireFeature(features.ByteStringNamedFilesystem)
2245
self.overrideEnv('HOME', '/home/\xa7test')
2246
self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
2247
self.assertEqual(u'/home/\xa7test', osutils._posix_get_home_dir())
2248
osutils._fs_enc = "iso8859-5"
2249
self.assertEqual(u'/home/\u0407test', osutils._posix_get_home_dir())
2250
osutils._fs_enc = "utf-8"
2251
self.assertRaises(errors.BadFilenameEncoding,
2252
osutils._posix_get_home_dir)
2255
class TestGetuserUnicode(tests.TestCase):
2257
def test_is_unicode(self):
2258
user = osutils.getuser_unicode()
2259
self.assertIsInstance(user, unicode)
2261
def envvar_to_override(self):
2262
if sys.platform == "win32":
2263
# Disable use of platform calls on windows so envvar is used
2264
self.overrideAttr(win32utils, 'has_ctypes', False)
2265
return 'USERNAME' # only variable used on windows
2266
return 'LOGNAME' # first variable checked by getpass.getuser()
2268
def test_ascii_user(self):
2269
self.overrideEnv(self.envvar_to_override(), 'jrandom')
2270
self.assertEqual(u'jrandom', osutils.getuser_unicode())
2272
def test_unicode_user(self):
2273
ue = osutils.get_user_encoding()
2274
uni_val, env_val = tests.probe_unicode_in_user_encoding()
2276
raise tests.TestSkipped(
2277
'Cannot find a unicode character that works in encoding %s'
2278
% (osutils.get_user_encoding(),))
2279
uni_username = u'jrandom' + uni_val
2280
encoded_username = uni_username.encode(ue)
2281
self.overrideEnv(self.envvar_to_override(), encoded_username)
2282
self.assertEqual(uni_username, osutils.getuser_unicode())
2285
class TestBackupNames(tests.TestCase):
2288
super(TestBackupNames, self).setUp()
2291
def backup_exists(self, name):
2292
return name in self.backups
2294
def available_backup_name(self, name):
2295
backup_name = osutils.available_backup_name(name, self.backup_exists)
2296
self.backups.append(backup_name)
2299
def assertBackupName(self, expected, name):
2300
self.assertEqual(expected, self.available_backup_name(name))
2302
def test_empty(self):
2303
self.assertBackupName('file.~1~', 'file')
2305
def test_existing(self):
2306
self.available_backup_name('file')
2307
self.available_backup_name('file')
2308
self.assertBackupName('file.~3~', 'file')
2309
# Empty slots are found, this is not a strict requirement and may be
2310
# revisited if we test against all implementations.
2311
self.backups.remove('file.~2~')
2312
self.assertBackupName('file.~2~', 'file')
2315
class TestFindExecutableInPath(tests.TestCase):
2317
def test_windows(self):
2318
if sys.platform != 'win32':
2319
raise tests.TestSkipped('test requires win32')
2320
self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
2322
osutils.find_executable_on_path('explorer.exe') is not None)
2324
osutils.find_executable_on_path('EXPLORER.EXE') is not None)
2326
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2327
self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
2329
def test_windows_app_path(self):
2330
if sys.platform != 'win32':
2331
raise tests.TestSkipped('test requires win32')
2332
# Override PATH env var so that exe can only be found on App Path
2333
self.overrideEnv('PATH', '')
2334
# Internt Explorer is always registered in the App Path
2335
self.assertTrue(osutils.find_executable_on_path('iexplore') is not None)
2337
def test_other(self):
2338
if sys.platform == 'win32':
2339
raise tests.TestSkipped('test requires non-win32')
2340
self.assertTrue(osutils.find_executable_on_path('sh') is not None)
2342
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2345
class TestEnvironmentErrors(tests.TestCase):
2346
"""Test handling of environmental errors"""
2348
def test_is_oserror(self):
2349
self.assertTrue(osutils.is_environment_error(
2350
OSError(errno.EINVAL, "Invalid parameter")))
2352
def test_is_ioerror(self):
2353
self.assertTrue(osutils.is_environment_error(
2354
IOError(errno.EINVAL, "Invalid parameter")))
2356
def test_is_socket_error(self):
2357
self.assertTrue(osutils.is_environment_error(
2358
socket.error(errno.EINVAL, "Invalid parameter")))
2360
def test_is_select_error(self):
2361
self.assertTrue(osutils.is_environment_error(
2362
select.error(errno.EINVAL, "Invalid parameter")))
2364
def test_is_pywintypes_error(self):
2365
self.requireFeature(features.pywintypes)
2367
self.assertTrue(osutils.is_environment_error(
2368
pywintypes.error(errno.EINVAL, "Invalid parameter", "Caller")))
added
removed
bzrlib/tests/test_osutils.py
