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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""Tests for the osutils wrapper."""
19
from cStringIO import StringIO
26
29
from bzrlib import (
31
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
32
38
from bzrlib.tests import (
40
class TestOSUtils(TestCaseInTempDir):
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):
42
107
def test_contains_whitespace(self):
43
self.failUnless(osutils.contains_whitespace(u' '))
44
self.failUnless(osutils.contains_whitespace(u'hello there'))
45
self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
46
self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
47
self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
48
self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
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
115
# \xa0 is "Non-breaking-space" which on some python locales thinks it
51
116
# is whitespace, but we do not.
52
self.failIf(osutils.contains_whitespace(u''))
53
self.failIf(osutils.contains_whitespace(u'hellothere'))
54
self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
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)
56
135
def test_fancy_rename(self):
57
136
# This should work everywhere
59
osutils.fancy_rename(a, b,
60
rename_func=os.rename,
61
unlink_func=os.unlink)
63
open('a', 'wb').write('something in a\n')
65
self.failIfExists('a')
66
self.failUnlessExists('b')
137
self.create_file('a', 'something in a\n')
138
self._fancy_rename('a', 'b')
139
self.assertPathDoesNotExist('a')
140
self.assertPathExists('b')
67
141
self.check_file_contents('b', 'something in a\n')
69
open('a', 'wb').write('new something in a\n')
143
self.create_file('a', 'new something in a\n')
144
self._fancy_rename('b', 'a')
72
146
self.check_file_contents('a', 'something in a\n')
148
def test_fancy_rename_fails_source_missing(self):
149
# An exception should be raised, and the target should be left in place
150
self.create_file('target', 'data in target\n')
151
self.assertRaises((IOError, OSError), self._fancy_rename,
152
'missingsource', 'target')
153
self.assertPathExists('target')
154
self.check_file_contents('target', 'data in target\n')
156
def test_fancy_rename_fails_if_source_and_target_missing(self):
157
self.assertRaises((IOError, OSError), self._fancy_rename,
158
'missingsource', 'missingtarget')
74
160
def test_rename(self):
75
161
# Rename should be semi-atomic on all platforms
76
open('a', 'wb').write('something in a\n')
162
self.create_file('a', 'something in a\n')
77
163
osutils.rename('a', 'b')
78
self.failIfExists('a')
79
self.failUnlessExists('b')
164
self.assertPathDoesNotExist('a')
165
self.assertPathExists('b')
80
166
self.check_file_contents('b', 'something in a\n')
82
open('a', 'wb').write('new something in a\n')
168
self.create_file('a', 'new something in a\n')
83
169
osutils.rename('b', 'a')
85
171
self.check_file_contents('a', 'something in a\n')
87
173
# TODO: test fancy_rename using a MemoryTransport
175
def test_rename_change_case(self):
176
# on Windows we should be able to change filename case by rename
177
self.build_tree(['a', 'b/'])
178
osutils.rename('a', 'A')
179
osutils.rename('b', 'B')
180
# we can't use failUnlessExists on case-insensitive filesystem
181
# so try to check shape of the tree
182
shape = sorted(os.listdir('.'))
183
self.assertEquals(['A', 'B'], shape)
185
def test_rename_exception(self):
187
osutils.rename('nonexistent_path', 'different_nonexistent_path')
189
self.assertEqual(e.old_filename, 'nonexistent_path')
190
self.assertEqual(e.new_filename, 'different_nonexistent_path')
191
self.assertTrue('nonexistent_path' in e.strerror)
192
self.assertTrue('different_nonexistent_path' in e.strerror)
195
class TestRandChars(tests.TestCase):
89
197
def test_01_rand_chars_empty(self):
90
198
result = osutils.rand_chars(0)
91
199
self.assertEqual(result, '')
240
509
foo_baz_path = osutils.pathjoin(foo_path, 'baz')
241
510
self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
244
class TestSafeUnicode(TestCase):
512
def test_changing_access(self):
513
f = file('file', 'w')
517
# Make a file readonly
518
osutils.make_readonly('file')
519
mode = os.lstat('file').st_mode
520
self.assertEqual(mode, mode & 0777555)
522
# Make a file writable
523
osutils.make_writable('file')
524
mode = os.lstat('file').st_mode
525
self.assertEqual(mode, mode | 0200)
527
if osutils.has_symlinks():
528
# should not error when handed a symlink
529
os.symlink('nonexistent', 'dangling')
530
osutils.make_readonly('dangling')
531
osutils.make_writable('dangling')
533
def test_host_os_dereferences_symlinks(self):
534
osutils.host_os_dereferences_symlinks()
537
class TestCanonicalRelPath(tests.TestCaseInTempDir):
539
_test_needs_features = [features.CaseInsCasePresFilenameFeature]
541
def test_canonical_relpath_simple(self):
542
f = file('MixedCaseName', 'w')
544
actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
545
self.assertEqual('work/MixedCaseName', actual)
547
def test_canonical_relpath_missing_tail(self):
548
os.mkdir('MixedCaseParent')
549
actual = osutils.canonical_relpath(self.test_base_dir,
550
'mixedcaseparent/nochild')
551
self.assertEqual('work/MixedCaseParent/nochild', actual)
554
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
556
def assertRelpath(self, expected, base, path):
557
actual = osutils._cicp_canonical_relpath(base, path)
558
self.assertEqual(expected, actual)
560
def test_simple(self):
561
self.build_tree(['MixedCaseName'])
562
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
563
self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
565
def test_subdir_missing_tail(self):
566
self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
567
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
568
self.assertRelpath('MixedCaseParent/a_child', base,
569
'MixedCaseParent/a_child')
570
self.assertRelpath('MixedCaseParent/a_child', base,
571
'MixedCaseParent/A_Child')
572
self.assertRelpath('MixedCaseParent/not_child', base,
573
'MixedCaseParent/not_child')
575
def test_at_root_slash(self):
576
# We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
578
if osutils.MIN_ABS_PATHLENGTH > 1:
579
raise tests.TestSkipped('relpath requires %d chars'
580
% osutils.MIN_ABS_PATHLENGTH)
581
self.assertRelpath('foo', '/', '/foo')
583
def test_at_root_drive(self):
584
if sys.platform != 'win32':
585
raise tests.TestNotApplicable('we can only test drive-letter relative'
586
' paths on Windows where we have drive'
589
# The specific issue is that when at the root of a drive, 'abspath'
590
# returns "C:/" or just "/". However, the code assumes that abspath
591
# always returns something like "C:/foo" or "/foo" (no trailing slash).
592
self.assertRelpath('foo', 'C:/', 'C:/foo')
593
self.assertRelpath('foo', 'X:/', 'X:/foo')
594
self.assertRelpath('foo', 'X:/', 'X://foo')
597
class TestPumpFile(tests.TestCase):
598
"""Test pumpfile method."""
601
super(TestPumpFile, self).setUp()
602
# create a test datablock
603
self.block_size = 512
604
pattern = '0123456789ABCDEF'
605
self.test_data = pattern * (3 * self.block_size / len(pattern))
606
self.test_data_len = len(self.test_data)
608
def test_bracket_block_size(self):
609
"""Read data in blocks with the requested read size bracketing the
611
# make sure test data is larger than max read size
612
self.assertTrue(self.test_data_len > self.block_size)
614
from_file = file_utils.FakeReadFile(self.test_data)
617
# read (max / 2) bytes and verify read size wasn't affected
618
num_bytes_to_read = self.block_size / 2
619
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
620
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
621
self.assertEqual(from_file.get_read_count(), 1)
623
# read (max) bytes and verify read size wasn't affected
624
num_bytes_to_read = self.block_size
625
from_file.reset_read_count()
626
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
627
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
628
self.assertEqual(from_file.get_read_count(), 1)
630
# read (max + 1) bytes and verify read size was limited
631
num_bytes_to_read = self.block_size + 1
632
from_file.reset_read_count()
633
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
634
self.assertEqual(from_file.get_max_read_size(), self.block_size)
635
self.assertEqual(from_file.get_read_count(), 2)
637
# finish reading the rest of the data
638
num_bytes_to_read = self.test_data_len - to_file.tell()
639
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
641
# report error if the data wasn't equal (we only report the size due
642
# to the length of the data)
643
response_data = to_file.getvalue()
644
if response_data != self.test_data:
645
message = "Data not equal. Expected %d bytes, received %d."
646
self.fail(message % (len(response_data), self.test_data_len))
648
def test_specified_size(self):
649
"""Request a transfer larger than the maximum block size and verify
650
that the maximum read doesn't exceed the block_size."""
651
# make sure test data is larger than max read size
652
self.assertTrue(self.test_data_len > self.block_size)
654
# retrieve data in blocks
655
from_file = file_utils.FakeReadFile(self.test_data)
657
osutils.pumpfile(from_file, to_file, self.test_data_len,
660
# verify read size was equal to the maximum read size
661
self.assertTrue(from_file.get_max_read_size() > 0)
662
self.assertEqual(from_file.get_max_read_size(), self.block_size)
663
self.assertEqual(from_file.get_read_count(), 3)
665
# report error if the data wasn't equal (we only report the size due
666
# to the length of the data)
667
response_data = to_file.getvalue()
668
if response_data != self.test_data:
669
message = "Data not equal. Expected %d bytes, received %d."
670
self.fail(message % (len(response_data), self.test_data_len))
672
def test_to_eof(self):
673
"""Read to end-of-file and verify that the reads are not larger than
674
the maximum read size."""
675
# make sure test data is larger than max read size
676
self.assertTrue(self.test_data_len > self.block_size)
678
# retrieve data to EOF
679
from_file = file_utils.FakeReadFile(self.test_data)
681
osutils.pumpfile(from_file, to_file, -1, self.block_size)
683
# verify read size was equal to the maximum read size
684
self.assertEqual(from_file.get_max_read_size(), self.block_size)
685
self.assertEqual(from_file.get_read_count(), 4)
687
# report error if the data wasn't equal (we only report the size due
688
# to the length of the data)
689
response_data = to_file.getvalue()
690
if response_data != self.test_data:
691
message = "Data not equal. Expected %d bytes, received %d."
692
self.fail(message % (len(response_data), self.test_data_len))
694
def test_defaults(self):
695
"""Verifies that the default arguments will read to EOF -- this
696
test verifies that any existing usages of pumpfile will not be broken
697
with this new version."""
698
# retrieve data using default (old) pumpfile method
699
from_file = file_utils.FakeReadFile(self.test_data)
701
osutils.pumpfile(from_file, to_file)
703
# report error if the data wasn't equal (we only report the size due
704
# to the length of the data)
705
response_data = to_file.getvalue()
706
if response_data != self.test_data:
707
message = "Data not equal. Expected %d bytes, received %d."
708
self.fail(message % (len(response_data), self.test_data_len))
710
def test_report_activity(self):
712
def log_activity(length, direction):
713
activity.append((length, direction))
714
from_file = StringIO(self.test_data)
716
osutils.pumpfile(from_file, to_file, buff_size=500,
717
report_activity=log_activity, direction='read')
718
self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
719
(36, 'read')], activity)
721
from_file = StringIO(self.test_data)
724
osutils.pumpfile(from_file, to_file, buff_size=500,
725
report_activity=log_activity, direction='write')
726
self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
727
(36, 'write')], activity)
729
# And with a limited amount of data
730
from_file = StringIO(self.test_data)
733
osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
734
report_activity=log_activity, direction='read')
735
self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
739
class TestPumpStringFile(tests.TestCase):
741
def test_empty(self):
743
osutils.pump_string_file("", output)
744
self.assertEqual("", output.getvalue())
746
def test_more_than_segment_size(self):
748
osutils.pump_string_file("123456789", output, 2)
749
self.assertEqual("123456789", output.getvalue())
751
def test_segment_size(self):
753
osutils.pump_string_file("12", output, 2)
754
self.assertEqual("12", output.getvalue())
756
def test_segment_size_multiple(self):
758
osutils.pump_string_file("1234", output, 2)
759
self.assertEqual("1234", output.getvalue())
762
class TestRelpath(tests.TestCase):
764
def test_simple_relpath(self):
765
cwd = osutils.getcwd()
766
subdir = cwd + '/subdir'
767
self.assertEqual('subdir', osutils.relpath(cwd, subdir))
769
def test_deep_relpath(self):
770
cwd = osutils.getcwd()
771
subdir = cwd + '/sub/subsubdir'
772
self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
774
def test_not_relative(self):
775
self.assertRaises(errors.PathNotChild,
776
osutils.relpath, 'C:/path', 'H:/path')
777
self.assertRaises(errors.PathNotChild,
778
osutils.relpath, 'C:/', 'H:/path')
781
class TestSafeUnicode(tests.TestCase):
246
783
def test_from_ascii_string(self):
247
784
self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
718
1448
result.append((dirdetail, new_dirblock))
719
1449
self.assertEqual(expected_dirblocks, result)
721
def test_unicode__walkdirs_unicode_to_utf8(self):
722
"""walkdirs_unicode_to_utf8 should be a safe fallback everywhere
1451
def test__walkdirs_utf8_with_unicode_fs(self):
1452
"""UnicodeDirReader should be a safe fallback everywhere
724
1454
The abspath portion should be in unicode
726
name0u = u'0file-\xb6'
727
name1u = u'1dir-\u062c\u0648'
728
name2u = u'2file-\u0633'
732
name1u + '/' + name0u,
733
name1u + '/' + name1u + '/',
1456
self.requireFeature(features.UnicodeFilenameFeature)
1457
# Use the unicode reader. TODO: split into driver-and-driven unit
1459
self._save_platform_info()
1460
osutils._selected_dir_reader = osutils.UnicodeDirReader()
1461
name0u = u'0file-\xb6'
1462
name1u = u'1dir-\u062c\u0648'
1463
name2u = u'2file-\u0633'
1467
name1u + '/' + name0u,
1468
name1u + '/' + name1u + '/',
1471
self.build_tree(tree)
1472
name0 = name0u.encode('utf8')
1473
name1 = name1u.encode('utf8')
1474
name2 = name2u.encode('utf8')
1476
# All of the abspaths should be in unicode, all of the relative paths
1478
expected_dirblocks = [
1480
[(name0, name0, 'file', './' + name0u),
1481
(name1, name1, 'directory', './' + name1u),
1482
(name2, name2, 'file', './' + name2u),
1485
((name1, './' + name1u),
1486
[(name1 + '/' + name0, name0, 'file', './' + name1u
1488
(name1 + '/' + name1, name1, 'directory', './' + name1u
1492
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1497
result = list(osutils._walkdirs_utf8('.'))
1498
self._filter_out_stat(result)
1499
self.assertEqual(expected_dirblocks, result)
1501
def test__walkdirs_utf8_win32readdir(self):
1502
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1503
self.requireFeature(features.UnicodeFilenameFeature)
1504
from bzrlib._walkdirs_win32 import Win32ReadDir
1505
self._save_platform_info()
1506
osutils._selected_dir_reader = Win32ReadDir()
1507
name0u = u'0file-\xb6'
1508
name1u = u'1dir-\u062c\u0648'
1509
name2u = u'2file-\u0633'
1513
name1u + '/' + name0u,
1514
name1u + '/' + name1u + '/',
1517
self.build_tree(tree)
1518
name0 = name0u.encode('utf8')
1519
name1 = name1u.encode('utf8')
1520
name2 = name2u.encode('utf8')
1522
# All of the abspaths should be in unicode, all of the relative paths
1524
expected_dirblocks = [
1526
[(name0, name0, 'file', './' + name0u),
1527
(name1, name1, 'directory', './' + name1u),
1528
(name2, name2, 'file', './' + name2u),
1531
((name1, './' + name1u),
1532
[(name1 + '/' + name0, name0, 'file', './' + name1u
1534
(name1 + '/' + name1, name1, 'directory', './' + name1u
1538
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1543
result = list(osutils._walkdirs_utf8(u'.'))
1544
self._filter_out_stat(result)
1545
self.assertEqual(expected_dirblocks, result)
1547
def assertStatIsCorrect(self, path, win32stat):
1548
os_stat = os.stat(path)
1549
self.assertEqual(os_stat.st_size, win32stat.st_size)
1550
self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
1551
self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
1552
self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
1553
self.assertEqual(os_stat.st_dev, win32stat.st_dev)
1554
self.assertEqual(os_stat.st_ino, win32stat.st_ino)
1555
self.assertEqual(os_stat.st_mode, win32stat.st_mode)
1557
def test__walkdirs_utf_win32_find_file_stat_file(self):
1558
"""make sure our Stat values are valid"""
1559
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1560
self.requireFeature(features.UnicodeFilenameFeature)
1561
from bzrlib._walkdirs_win32 import Win32ReadDir
1562
name0u = u'0file-\xb6'
1563
name0 = name0u.encode('utf8')
1564
self.build_tree([name0u])
1565
# I hate to sleep() here, but I'm trying to make the ctime different
1568
f = open(name0u, 'ab')
737
self.build_tree(tree)
739
raise TestSkipped('Could not represent Unicode chars'
740
' in current encoding.')
1570
f.write('just a small update')
1574
result = Win32ReadDir().read_dir('', u'.')
1576
self.assertEqual((name0, name0, 'file'), entry[:3])
1577
self.assertEqual(u'./' + name0u, entry[4])
1578
self.assertStatIsCorrect(entry[4], entry[3])
1579
self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
1581
def test__walkdirs_utf_win32_find_file_stat_directory(self):
1582
"""make sure our Stat values are valid"""
1583
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1584
self.requireFeature(features.UnicodeFilenameFeature)
1585
from bzrlib._walkdirs_win32 import Win32ReadDir
1586
name0u = u'0dir-\u062c\u0648'
741
1587
name0 = name0u.encode('utf8')
742
name1 = name1u.encode('utf8')
743
name2 = name2u.encode('utf8')
1588
self.build_tree([name0u + '/'])
745
# All of the abspaths should be in unicode, all of the relative paths
747
expected_dirblocks = [
749
[(name0, name0, 'file', './' + name0u),
750
(name1, name1, 'directory', './' + name1u),
751
(name2, name2, 'file', './' + name2u),
754
((name1, './' + name1u),
755
[(name1 + '/' + name0, name0, 'file', './' + name1u
757
(name1 + '/' + name1, name1, 'directory', './' + name1u
761
((name1 + '/' + name1, './' + name1u + '/' + name1u),
766
result = list(osutils._walkdirs_unicode_to_utf8('.'))
767
self._filter_out_stat(result)
768
self.assertEqual(expected_dirblocks, result)
1590
result = Win32ReadDir().read_dir('', u'.')
1592
self.assertEqual((name0, name0, 'directory'), entry[:3])
1593
self.assertEqual(u'./' + name0u, entry[4])
1594
self.assertStatIsCorrect(entry[4], entry[3])
770
1596
def assertPathCompare(self, path_less, path_greater):
771
1597
"""check that path_less and path_greater compare correctly."""
959
1770
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
960
1771
self.assertEqual('foo', old)
961
1772
self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
962
self.failIf('BZR_TEST_ENV_VAR' in os.environ)
965
class TestLocalTimeOffset(TestCase):
967
def test_local_time_offset(self):
968
"""Test that local_time_offset() returns a sane value."""
969
offset = osutils.local_time_offset()
970
self.assertTrue(isinstance(offset, int))
971
# Test that the offset is no more than a eighteen hours in
973
# Time zone handling is system specific, so it is difficult to
974
# do more specific tests, but a value outside of this range is
976
eighteen_hours = 18 * 3600
977
self.assertTrue(-eighteen_hours < offset < eighteen_hours)
979
def test_local_time_offset_with_timestamp(self):
980
"""Test that local_time_offset() works with a timestamp."""
981
offset = osutils.local_time_offset(1000000000.1234567)
982
self.assertTrue(isinstance(offset, int))
983
eighteen_hours = 18 * 3600
984
self.assertTrue(-eighteen_hours < offset < eighteen_hours)
1773
self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1776
class TestSizeShaFile(tests.TestCaseInTempDir):
1778
def test_sha_empty(self):
1779
self.build_tree_contents([('foo', '')])
1780
expected_sha = osutils.sha_string('')
1782
self.addCleanup(f.close)
1783
size, sha = osutils.size_sha_file(f)
1784
self.assertEqual(0, size)
1785
self.assertEqual(expected_sha, sha)
1787
def test_sha_mixed_endings(self):
1788
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1789
self.build_tree_contents([('foo', text)])
1790
expected_sha = osutils.sha_string(text)
1791
f = open('foo', 'rb')
1792
self.addCleanup(f.close)
1793
size, sha = osutils.size_sha_file(f)
1794
self.assertEqual(38, size)
1795
self.assertEqual(expected_sha, sha)
1798
class TestShaFileByName(tests.TestCaseInTempDir):
1800
def test_sha_empty(self):
1801
self.build_tree_contents([('foo', '')])
1802
expected_sha = osutils.sha_string('')
1803
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1805
def test_sha_mixed_endings(self):
1806
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1807
self.build_tree_contents([('foo', text)])
1808
expected_sha = osutils.sha_string(text)
1809
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1812
class TestResourceLoading(tests.TestCaseInTempDir):
1814
def test_resource_string(self):
1815
# test resource in bzrlib
1816
text = osutils.resource_string('bzrlib', 'debug.py')
1817
self.assertContainsRe(text, "debug_flags = set()")
1818
# test resource under bzrlib
1819
text = osutils.resource_string('bzrlib.ui', 'text.py')
1820
self.assertContainsRe(text, "class TextUIFactory")
1821
# test unsupported package
1822
self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
1824
# test unknown resource
1825
self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
1828
class TestReCompile(tests.TestCase):
1830
def _deprecated_re_compile_checked(self, *args, **kwargs):
1831
return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1832
osutils.re_compile_checked, *args, **kwargs)
1834
def test_re_compile_checked(self):
1835
r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1836
self.assertTrue(r.match('aaaa'))
1837
self.assertTrue(r.match('aAaA'))
1839
def test_re_compile_checked_error(self):
1840
# like https://bugs.launchpad.net/bzr/+bug/251352
1842
# Due to possible test isolation error, re.compile is not lazy at
1843
# this point. We re-install lazy compile.
1844
lazy_regex.install_lazy_compile()
1845
err = self.assertRaises(
1846
errors.BzrCommandError,
1847
self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1849
'Invalid regular expression in test case: '
1850
'"*" nothing to repeat',
1854
class TestDirReader(tests.TestCaseInTempDir):
1856
scenarios = dir_reader_scenarios()
1859
_dir_reader_class = None
1860
_native_to_unicode = None
1863
super(TestDirReader, self).setUp()
1864
self.overrideAttr(osutils,
1865
'_selected_dir_reader', self._dir_reader_class())
1867
def _get_ascii_tree(self):
1875
expected_dirblocks = [
1877
[('0file', '0file', 'file'),
1878
('1dir', '1dir', 'directory'),
1879
('2file', '2file', 'file'),
1882
(('1dir', './1dir'),
1883
[('1dir/0file', '0file', 'file'),
1884
('1dir/1dir', '1dir', 'directory'),
1887
(('1dir/1dir', './1dir/1dir'),
1892
return tree, expected_dirblocks
1894
def test_walk_cur_dir(self):
1895
tree, expected_dirblocks = self._get_ascii_tree()
1896
self.build_tree(tree)
1897
result = list(osutils._walkdirs_utf8('.'))
1898
# Filter out stat and abspath
1899
self.assertEqual(expected_dirblocks,
1900
[(dirinfo, [line[0:3] for line in block])
1901
for dirinfo, block in result])
1903
def test_walk_sub_dir(self):
1904
tree, expected_dirblocks = self._get_ascii_tree()
1905
self.build_tree(tree)
1906
# you can search a subdir only, with a supplied prefix.
1907
result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
1908
# Filter out stat and abspath
1909
self.assertEqual(expected_dirblocks[1:],
1910
[(dirinfo, [line[0:3] for line in block])
1911
for dirinfo, block in result])
1913
def _get_unicode_tree(self):
1914
name0u = u'0file-\xb6'
1915
name1u = u'1dir-\u062c\u0648'
1916
name2u = u'2file-\u0633'
1920
name1u + '/' + name0u,
1921
name1u + '/' + name1u + '/',
1924
name0 = name0u.encode('UTF-8')
1925
name1 = name1u.encode('UTF-8')
1926
name2 = name2u.encode('UTF-8')
1927
expected_dirblocks = [
1929
[(name0, name0, 'file', './' + name0u),
1930
(name1, name1, 'directory', './' + name1u),
1931
(name2, name2, 'file', './' + name2u),
1934
((name1, './' + name1u),
1935
[(name1 + '/' + name0, name0, 'file', './' + name1u
1937
(name1 + '/' + name1, name1, 'directory', './' + name1u
1941
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1946
return tree, expected_dirblocks
1948
def _filter_out(self, raw_dirblocks):
1949
"""Filter out a walkdirs_utf8 result.
1951
stat field is removed, all native paths are converted to unicode
1953
filtered_dirblocks = []
1954
for dirinfo, block in raw_dirblocks:
1955
dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
1958
details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
1959
filtered_dirblocks.append((dirinfo, details))
1960
return filtered_dirblocks
1962
def test_walk_unicode_tree(self):
1963
self.requireFeature(features.UnicodeFilenameFeature)
1964
tree, expected_dirblocks = self._get_unicode_tree()
1965
self.build_tree(tree)
1966
result = list(osutils._walkdirs_utf8('.'))
1967
self.assertEqual(expected_dirblocks, self._filter_out(result))
1969
def test_symlink(self):
1970
self.requireFeature(features.SymlinkFeature)
1971
self.requireFeature(features.UnicodeFilenameFeature)
1972
target = u'target\N{Euro Sign}'
1973
link_name = u'l\N{Euro Sign}nk'
1974
os.symlink(target, link_name)
1975
target_utf8 = target.encode('UTF-8')
1976
link_name_utf8 = link_name.encode('UTF-8')
1977
expected_dirblocks = [
1979
[(link_name_utf8, link_name_utf8,
1980
'symlink', './' + link_name),],
1982
result = list(osutils._walkdirs_utf8('.'))
1983
self.assertEqual(expected_dirblocks, self._filter_out(result))
1986
class TestReadLink(tests.TestCaseInTempDir):
1987
"""Exposes os.readlink() problems and the osutils solution.
1989
The only guarantee offered by os.readlink(), starting with 2.6, is that a
1990
unicode string will be returned if a unicode string is passed.
1992
But prior python versions failed to properly encode the passed unicode
1995
_test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
1998
super(tests.TestCaseInTempDir, self).setUp()
1999
self.link = u'l\N{Euro Sign}ink'
2000
self.target = u'targe\N{Euro Sign}t'
2001
os.symlink(self.target, self.link)
2003
def test_os_readlink_link_encoding(self):
2004
self.assertEquals(self.target, os.readlink(self.link))
2006
def test_os_readlink_link_decoding(self):
2007
self.assertEquals(self.target.encode(osutils._fs_enc),
2008
os.readlink(self.link.encode(osutils._fs_enc)))
2011
class TestConcurrency(tests.TestCase):
2014
super(TestConcurrency, self).setUp()
2015
self.overrideAttr(osutils, '_cached_local_concurrency')
2017
def test_local_concurrency(self):
2018
concurrency = osutils.local_concurrency()
2019
self.assertIsInstance(concurrency, int)
2021
def test_local_concurrency_environment_variable(self):
2022
self.overrideEnv('BZR_CONCURRENCY', '2')
2023
self.assertEqual(2, osutils.local_concurrency(use_cache=False))
2024
self.overrideEnv('BZR_CONCURRENCY', '3')
2025
self.assertEqual(3, osutils.local_concurrency(use_cache=False))
2026
self.overrideEnv('BZR_CONCURRENCY', 'foo')
2027
self.assertEqual(1, osutils.local_concurrency(use_cache=False))
2029
def test_option_concurrency(self):
2030
self.overrideEnv('BZR_CONCURRENCY', '1')
2031
self.run_bzr('rocks --concurrency 42')
2032
# Command line overrides environment variable
2033
self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
2034
self.assertEquals(42, osutils.local_concurrency(use_cache=False))
2037
class TestFailedToLoadExtension(tests.TestCase):
2039
def _try_loading(self):
2041
import bzrlib._fictional_extension_py
2042
except ImportError, e:
2043
osutils.failed_to_load_extension(e)
2047
super(TestFailedToLoadExtension, self).setUp()
2048
self.overrideAttr(osutils, '_extension_load_failures', [])
2050
def test_failure_to_load(self):
2052
self.assertLength(1, osutils._extension_load_failures)
2053
self.assertEquals(osutils._extension_load_failures[0],
2054
"No module named _fictional_extension_py")
2056
def test_report_extension_load_failures_no_warning(self):
2057
self.assertTrue(self._try_loading())
2058
warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
2059
# it used to give a Python warning; it no longer does
2060
self.assertLength(0, warnings)
2062
def test_report_extension_load_failures_message(self):
2064
trace.push_log_file(log)
2065
self.assertTrue(self._try_loading())
2066
osutils.report_extension_load_failures()
2067
self.assertContainsRe(
2069
r"bzr: warning: some compiled extensions could not be loaded; "
2070
"see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
2074
class TestTerminalWidth(tests.TestCase):
2077
super(TestTerminalWidth, self).setUp()
2078
self._orig_terminal_size_state = osutils._terminal_size_state
2079
self._orig_first_terminal_size = osutils._first_terminal_size
2080
self.addCleanup(self.restore_osutils_globals)
2081
osutils._terminal_size_state = 'no_data'
2082
osutils._first_terminal_size = None
2084
def restore_osutils_globals(self):
2085
osutils._terminal_size_state = self._orig_terminal_size_state
2086
osutils._first_terminal_size = self._orig_first_terminal_size
2088
def replace_stdout(self, new):
2089
self.overrideAttr(sys, 'stdout', new)
2091
def replace__terminal_size(self, new):
2092
self.overrideAttr(osutils, '_terminal_size', new)
2094
def set_fake_tty(self):
2096
class I_am_a_tty(object):
2100
self.replace_stdout(I_am_a_tty())
2102
def test_default_values(self):
2103
self.assertEqual(80, osutils.default_terminal_width)
2105
def test_defaults_to_BZR_COLUMNS(self):
2106
# BZR_COLUMNS is set by the test framework
2107
self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
2108
self.overrideEnv('BZR_COLUMNS', '12')
2109
self.assertEqual(12, osutils.terminal_width())
2111
def test_BZR_COLUMNS_0_no_limit(self):
2112
self.overrideEnv('BZR_COLUMNS', '0')
2113
self.assertEqual(None, osutils.terminal_width())
2115
def test_falls_back_to_COLUMNS(self):
2116
self.overrideEnv('BZR_COLUMNS', None)
2117
self.assertNotEqual('42', os.environ['COLUMNS'])
2119
self.overrideEnv('COLUMNS', '42')
2120
self.assertEqual(42, osutils.terminal_width())
2122
def test_tty_default_without_columns(self):
2123
self.overrideEnv('BZR_COLUMNS', None)
2124
self.overrideEnv('COLUMNS', None)
2126
def terminal_size(w, h):
2130
# We need to override the osutils definition as it depends on the
2131
# running environment that we can't control (PQM running without a
2132
# controlling terminal is one example).
2133
self.replace__terminal_size(terminal_size)
2134
self.assertEqual(42, osutils.terminal_width())
2136
def test_non_tty_default_without_columns(self):
2137
self.overrideEnv('BZR_COLUMNS', None)
2138
self.overrideEnv('COLUMNS', None)
2139
self.replace_stdout(None)
2140
self.assertEqual(None, osutils.terminal_width())
2142
def test_no_TIOCGWINSZ(self):
2143
self.requireFeature(term_ios_feature)
2144
termios = term_ios_feature.module
2145
# bug 63539 is about a termios without TIOCGWINSZ attribute
2147
orig = termios.TIOCGWINSZ
2148
except AttributeError:
2149
# We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
2152
self.overrideAttr(termios, 'TIOCGWINSZ')
2153
del termios.TIOCGWINSZ
2154
self.overrideEnv('BZR_COLUMNS', None)
2155
self.overrideEnv('COLUMNS', None)
2156
# Whatever the result is, if we don't raise an exception, it's ok.
2157
osutils.terminal_width()
2160
class TestCreationOps(tests.TestCaseInTempDir):
2161
_test_needs_features = [features.chown_feature]
2164
super(TestCreationOps, self).setUp()
2165
self.overrideAttr(os, 'chown', self._dummy_chown)
2167
# params set by call to _dummy_chown
2168
self.path = self.uid = self.gid = None
2170
def _dummy_chown(self, path, uid, gid):
2171
self.path, self.uid, self.gid = path, uid, gid
2173
def test_copy_ownership_from_path(self):
2174
"""copy_ownership_from_path test with specified src."""
2176
f = open('test_file', 'wt')
2177
osutils.copy_ownership_from_path('test_file', ownsrc)
2180
self.assertEquals(self.path, 'test_file')
2181
self.assertEquals(self.uid, s.st_uid)
2182
self.assertEquals(self.gid, s.st_gid)
2184
def test_copy_ownership_nonesrc(self):
2185
"""copy_ownership_from_path test with src=None."""
2186
f = open('test_file', 'wt')
2187
# should use parent dir for permissions
2188
osutils.copy_ownership_from_path('test_file')
2191
self.assertEquals(self.path, 'test_file')
2192
self.assertEquals(self.uid, s.st_uid)
2193
self.assertEquals(self.gid, s.st_gid)
2196
class TestPathFromEnviron(tests.TestCase):
2198
def test_is_unicode(self):
2199
self.overrideEnv('BZR_TEST_PATH', './anywhere at all/')
2200
path = osutils.path_from_environ('BZR_TEST_PATH')
2201
self.assertIsInstance(path, unicode)
2202
self.assertEqual(u'./anywhere at all/', path)
2204
def test_posix_path_env_ascii(self):
2205
self.overrideEnv('BZR_TEST_PATH', '/tmp')
2206
home = osutils._posix_path_from_environ('BZR_TEST_PATH')
2207
self.assertIsInstance(home, unicode)
2208
self.assertEqual(u'/tmp', home)
2210
def test_posix_path_env_unicode(self):
2211
self.requireFeature(features.ByteStringNamedFilesystem)
2212
self.overrideEnv('BZR_TEST_PATH', '/home/\xa7test')
2213
self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
2214
self.assertEqual(u'/home/\xa7test',
2215
osutils._posix_path_from_environ('BZR_TEST_PATH'))
2216
osutils._fs_enc = "iso8859-5"
2217
self.assertEqual(u'/home/\u0407test',
2218
osutils._posix_path_from_environ('BZR_TEST_PATH'))
2219
osutils._fs_enc = "utf-8"
2220
self.assertRaises(errors.BadFilenameEncoding,
2221
osutils._posix_path_from_environ, 'BZR_TEST_PATH')
2224
class TestGetHomeDir(tests.TestCase):
2226
def test_is_unicode(self):
2227
home = osutils._get_home_dir()
2228
self.assertIsInstance(home, unicode)
2230
def test_posix_homeless(self):
2231
self.overrideEnv('HOME', None)
2232
home = osutils._get_home_dir()
2233
self.assertIsInstance(home, unicode)
2235
def test_posix_home_ascii(self):
2236
self.overrideEnv('HOME', '/home/test')
2237
home = osutils._posix_get_home_dir()
2238
self.assertIsInstance(home, unicode)
2239
self.assertEqual(u'/home/test', home)
2241
def test_posix_home_unicode(self):
2242
self.requireFeature(features.ByteStringNamedFilesystem)
2243
self.overrideEnv('HOME', '/home/\xa7test')
2244
self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
2245
self.assertEqual(u'/home/\xa7test', osutils._posix_get_home_dir())
2246
osutils._fs_enc = "iso8859-5"
2247
self.assertEqual(u'/home/\u0407test', osutils._posix_get_home_dir())
2248
osutils._fs_enc = "utf-8"
2249
self.assertRaises(errors.BadFilenameEncoding,
2250
osutils._posix_get_home_dir)
2253
class TestGetuserUnicode(tests.TestCase):
2255
def test_is_unicode(self):
2256
user = osutils.getuser_unicode()
2257
self.assertIsInstance(user, unicode)
2259
def envvar_to_override(self):
2260
if sys.platform == "win32":
2261
# Disable use of platform calls on windows so envvar is used
2262
self.overrideAttr(win32utils, 'has_ctypes', False)
2263
return 'USERNAME' # only variable used on windows
2264
return 'LOGNAME' # first variable checked by getpass.getuser()
2266
def test_ascii_user(self):
2267
self.overrideEnv(self.envvar_to_override(), 'jrandom')
2268
self.assertEqual(u'jrandom', osutils.getuser_unicode())
2270
def test_unicode_user(self):
2271
ue = osutils.get_user_encoding()
2272
uni_val, env_val = tests.probe_unicode_in_user_encoding()
2274
raise tests.TestSkipped(
2275
'Cannot find a unicode character that works in encoding %s'
2276
% (osutils.get_user_encoding(),))
2277
uni_username = u'jrandom' + uni_val
2278
encoded_username = uni_username.encode(ue)
2279
self.overrideEnv(self.envvar_to_override(), encoded_username)
2280
self.assertEqual(uni_username, osutils.getuser_unicode())
2283
class TestBackupNames(tests.TestCase):
2286
super(TestBackupNames, self).setUp()
2289
def backup_exists(self, name):
2290
return name in self.backups
2292
def available_backup_name(self, name):
2293
backup_name = osutils.available_backup_name(name, self.backup_exists)
2294
self.backups.append(backup_name)
2297
def assertBackupName(self, expected, name):
2298
self.assertEqual(expected, self.available_backup_name(name))
2300
def test_empty(self):
2301
self.assertBackupName('file.~1~', 'file')
2303
def test_existing(self):
2304
self.available_backup_name('file')
2305
self.available_backup_name('file')
2306
self.assertBackupName('file.~3~', 'file')
2307
# Empty slots are found, this is not a strict requirement and may be
2308
# revisited if we test against all implementations.
2309
self.backups.remove('file.~2~')
2310
self.assertBackupName('file.~2~', 'file')
2313
class TestFindExecutableInPath(tests.TestCase):
2315
def test_windows(self):
2316
if sys.platform != 'win32':
2317
raise tests.TestSkipped('test requires win32')
2318
self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
2320
osutils.find_executable_on_path('explorer.exe') is not None)
2322
osutils.find_executable_on_path('EXPLORER.EXE') is not None)
2324
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2325
self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
2327
def test_windows_app_path(self):
2328
if sys.platform != 'win32':
2329
raise tests.TestSkipped('test requires win32')
2330
# Override PATH env var so that exe can only be found on App Path
2331
self.overrideEnv('PATH', '')
2332
# Internt Explorer is always registered in the App Path
2333
self.assertTrue(osutils.find_executable_on_path('iexplore') is not None)
2335
def test_other(self):
2336
if sys.platform == 'win32':
2337
raise tests.TestSkipped('test requires non-win32')
2338
self.assertTrue(osutils.find_executable_on_path('sh') is not None)
2340
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2343
class TestEnvironmentErrors(tests.TestCase):
2344
"""Test handling of environmental errors"""
2346
def test_is_oserror(self):
2347
self.assertTrue(osutils.is_environment_error(
2348
OSError(errno.EINVAL, "Invalid parameter")))
2350
def test_is_ioerror(self):
2351
self.assertTrue(osutils.is_environment_error(
2352
IOError(errno.EINVAL, "Invalid parameter")))
2354
def test_is_socket_error(self):
2355
self.assertTrue(osutils.is_environment_error(
2356
socket.error(errno.EINVAL, "Invalid parameter")))
2358
def test_is_select_error(self):
2359
self.assertTrue(osutils.is_environment_error(
2360
select.error(errno.EINVAL, "Invalid parameter")))
2362
def test_is_pywintypes_error(self):
2363
self.requireFeature(features.pywintypes)
2365
self.assertTrue(osutils.is_environment_error(
2366
pywintypes.error(errno.EINVAL, "Invalid parameter", "Caller")))
added
removed
bzrlib/tests/test_osutils.py
