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
28
from bzrlib import (
31
from bzrlib.errors import BzrBadParameterNotUnicode, InvalidURL
32
37
from bzrlib.tests import (
40
class TestOSUtils(TestCaseInTempDir):
42
from bzrlib.tests.scenarios import load_tests_apply_scenarios
45
class _UTF8DirReaderFeature(features.Feature):
49
from bzrlib import _readdir_pyx
50
self.reader = _readdir_pyx.UTF8DirReader
55
def feature_name(self):
56
return 'bzrlib._readdir_pyx'
58
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
60
term_ios_feature = features.ModuleAvailableFeature('termios')
63
def _already_unicode(s):
67
def _utf8_to_unicode(s):
68
return s.decode('UTF-8')
71
def dir_reader_scenarios():
72
# For each dir reader we define:
74
# - native_to_unicode: a function converting the native_abspath as returned
75
# by DirReader.read_dir to its unicode representation
77
# UnicodeDirReader is the fallback, it should be tested on all platforms.
78
scenarios = [('unicode',
79
dict(_dir_reader_class=osutils.UnicodeDirReader,
80
_native_to_unicode=_already_unicode))]
81
# Some DirReaders are platform specific and even there they may not be
83
if UTF8DirReaderFeature.available():
84
from bzrlib import _readdir_pyx
85
scenarios.append(('utf8',
86
dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
87
_native_to_unicode=_utf8_to_unicode)))
89
if test__walkdirs_win32.win32_readdir_feature.available():
91
from bzrlib import _walkdirs_win32
94
dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
95
_native_to_unicode=_already_unicode)))
101
load_tests = load_tests_apply_scenarios
104
class TestContainsWhitespace(tests.TestCase):
42
106
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'))
107
self.assertTrue(osutils.contains_whitespace(u' '))
108
self.assertTrue(osutils.contains_whitespace(u'hello there'))
109
self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
110
self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
111
self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
112
self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
50
114
# \xa0 is "Non-breaking-space" which on some python locales thinks it
51
115
# 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'))
116
self.assertFalse(osutils.contains_whitespace(u''))
117
self.assertFalse(osutils.contains_whitespace(u'hellothere'))
118
self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
121
class TestRename(tests.TestCaseInTempDir):
123
def create_file(self, filename, content):
124
f = open(filename, 'wb')
130
def _fancy_rename(self, a, b):
131
osutils.fancy_rename(a, b, rename_func=os.rename,
132
unlink_func=os.unlink)
56
134
def test_fancy_rename(self):
57
135
# 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')
136
self.create_file('a', 'something in a\n')
137
self._fancy_rename('a', 'b')
138
self.assertPathDoesNotExist('a')
139
self.assertPathExists('b')
67
140
self.check_file_contents('b', 'something in a\n')
69
open('a', 'wb').write('new something in a\n')
142
self.create_file('a', 'new something in a\n')
143
self._fancy_rename('b', 'a')
72
145
self.check_file_contents('a', 'something in a\n')
147
def test_fancy_rename_fails_source_missing(self):
148
# An exception should be raised, and the target should be left in place
149
self.create_file('target', 'data in target\n')
150
self.assertRaises((IOError, OSError), self._fancy_rename,
151
'missingsource', 'target')
152
self.assertPathExists('target')
153
self.check_file_contents('target', 'data in target\n')
155
def test_fancy_rename_fails_if_source_and_target_missing(self):
156
self.assertRaises((IOError, OSError), self._fancy_rename,
157
'missingsource', 'missingtarget')
74
159
def test_rename(self):
75
160
# Rename should be semi-atomic on all platforms
76
open('a', 'wb').write('something in a\n')
161
self.create_file('a', 'something in a\n')
77
162
osutils.rename('a', 'b')
78
self.failIfExists('a')
79
self.failUnlessExists('b')
163
self.assertPathDoesNotExist('a')
164
self.assertPathExists('b')
80
165
self.check_file_contents('b', 'something in a\n')
82
open('a', 'wb').write('new something in a\n')
167
self.create_file('a', 'new something in a\n')
83
168
osutils.rename('b', 'a')
85
170
self.check_file_contents('a', 'something in a\n')
87
172
# TODO: test fancy_rename using a MemoryTransport
174
def test_rename_change_case(self):
175
# on Windows we should be able to change filename case by rename
176
self.build_tree(['a', 'b/'])
177
osutils.rename('a', 'A')
178
osutils.rename('b', 'B')
179
# we can't use failUnlessExists on case-insensitive filesystem
180
# so try to check shape of the tree
181
shape = sorted(os.listdir('.'))
182
self.assertEquals(['A', 'B'], shape)
185
class TestRandChars(tests.TestCase):
89
187
def test_01_rand_chars_empty(self):
90
188
result = osutils.rand_chars(0)
91
189
self.assertEqual(result, '')
240
456
foo_baz_path = osutils.pathjoin(foo_path, 'baz')
241
457
self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
244
class TestSafeUnicode(TestCase):
459
def test_changing_access(self):
460
f = file('file', 'w')
464
# Make a file readonly
465
osutils.make_readonly('file')
466
mode = os.lstat('file').st_mode
467
self.assertEqual(mode, mode & 0777555)
469
# Make a file writable
470
osutils.make_writable('file')
471
mode = os.lstat('file').st_mode
472
self.assertEqual(mode, mode | 0200)
474
if osutils.has_symlinks():
475
# should not error when handed a symlink
476
os.symlink('nonexistent', 'dangling')
477
osutils.make_readonly('dangling')
478
osutils.make_writable('dangling')
480
def test_host_os_dereferences_symlinks(self):
481
osutils.host_os_dereferences_symlinks()
484
class TestCanonicalRelPath(tests.TestCaseInTempDir):
486
_test_needs_features = [features.CaseInsCasePresFilenameFeature]
488
def test_canonical_relpath_simple(self):
489
f = file('MixedCaseName', 'w')
491
actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
492
self.assertEqual('work/MixedCaseName', actual)
494
def test_canonical_relpath_missing_tail(self):
495
os.mkdir('MixedCaseParent')
496
actual = osutils.canonical_relpath(self.test_base_dir,
497
'mixedcaseparent/nochild')
498
self.assertEqual('work/MixedCaseParent/nochild', actual)
501
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
503
def assertRelpath(self, expected, base, path):
504
actual = osutils._cicp_canonical_relpath(base, path)
505
self.assertEqual(expected, actual)
507
def test_simple(self):
508
self.build_tree(['MixedCaseName'])
509
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
510
self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
512
def test_subdir_missing_tail(self):
513
self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
514
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
515
self.assertRelpath('MixedCaseParent/a_child', base,
516
'MixedCaseParent/a_child')
517
self.assertRelpath('MixedCaseParent/a_child', base,
518
'MixedCaseParent/A_Child')
519
self.assertRelpath('MixedCaseParent/not_child', base,
520
'MixedCaseParent/not_child')
522
def test_at_root_slash(self):
523
# We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
525
if osutils.MIN_ABS_PATHLENGTH > 1:
526
raise tests.TestSkipped('relpath requires %d chars'
527
% osutils.MIN_ABS_PATHLENGTH)
528
self.assertRelpath('foo', '/', '/foo')
530
def test_at_root_drive(self):
531
if sys.platform != 'win32':
532
raise tests.TestNotApplicable('we can only test drive-letter relative'
533
' paths on Windows where we have drive'
536
# The specific issue is that when at the root of a drive, 'abspath'
537
# returns "C:/" or just "/". However, the code assumes that abspath
538
# always returns something like "C:/foo" or "/foo" (no trailing slash).
539
self.assertRelpath('foo', 'C:/', 'C:/foo')
540
self.assertRelpath('foo', 'X:/', 'X:/foo')
541
self.assertRelpath('foo', 'X:/', 'X://foo')
544
class TestPumpFile(tests.TestCase):
545
"""Test pumpfile method."""
548
tests.TestCase.setUp(self)
549
# create a test datablock
550
self.block_size = 512
551
pattern = '0123456789ABCDEF'
552
self.test_data = pattern * (3 * self.block_size / len(pattern))
553
self.test_data_len = len(self.test_data)
555
def test_bracket_block_size(self):
556
"""Read data in blocks with the requested read size bracketing the
558
# make sure test data is larger than max read size
559
self.assertTrue(self.test_data_len > self.block_size)
561
from_file = file_utils.FakeReadFile(self.test_data)
564
# read (max / 2) bytes and verify read size wasn't affected
565
num_bytes_to_read = self.block_size / 2
566
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
567
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
568
self.assertEqual(from_file.get_read_count(), 1)
570
# read (max) bytes and verify read size wasn't affected
571
num_bytes_to_read = self.block_size
572
from_file.reset_read_count()
573
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
574
self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
575
self.assertEqual(from_file.get_read_count(), 1)
577
# read (max + 1) bytes and verify read size was limited
578
num_bytes_to_read = self.block_size + 1
579
from_file.reset_read_count()
580
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
581
self.assertEqual(from_file.get_max_read_size(), self.block_size)
582
self.assertEqual(from_file.get_read_count(), 2)
584
# finish reading the rest of the data
585
num_bytes_to_read = self.test_data_len - to_file.tell()
586
osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
588
# report error if the data wasn't equal (we only report the size due
589
# to the length of the data)
590
response_data = to_file.getvalue()
591
if response_data != self.test_data:
592
message = "Data not equal. Expected %d bytes, received %d."
593
self.fail(message % (len(response_data), self.test_data_len))
595
def test_specified_size(self):
596
"""Request a transfer larger than the maximum block size and verify
597
that the maximum read doesn't exceed the block_size."""
598
# make sure test data is larger than max read size
599
self.assertTrue(self.test_data_len > self.block_size)
601
# retrieve data in blocks
602
from_file = file_utils.FakeReadFile(self.test_data)
604
osutils.pumpfile(from_file, to_file, self.test_data_len,
607
# verify read size was equal to the maximum read size
608
self.assertTrue(from_file.get_max_read_size() > 0)
609
self.assertEqual(from_file.get_max_read_size(), self.block_size)
610
self.assertEqual(from_file.get_read_count(), 3)
612
# report error if the data wasn't equal (we only report the size due
613
# to the length of the data)
614
response_data = to_file.getvalue()
615
if response_data != self.test_data:
616
message = "Data not equal. Expected %d bytes, received %d."
617
self.fail(message % (len(response_data), self.test_data_len))
619
def test_to_eof(self):
620
"""Read to end-of-file and verify that the reads are not larger than
621
the maximum read size."""
622
# make sure test data is larger than max read size
623
self.assertTrue(self.test_data_len > self.block_size)
625
# retrieve data to EOF
626
from_file = file_utils.FakeReadFile(self.test_data)
628
osutils.pumpfile(from_file, to_file, -1, self.block_size)
630
# verify read size was equal to the maximum read size
631
self.assertEqual(from_file.get_max_read_size(), self.block_size)
632
self.assertEqual(from_file.get_read_count(), 4)
634
# report error if the data wasn't equal (we only report the size due
635
# to the length of the data)
636
response_data = to_file.getvalue()
637
if response_data != self.test_data:
638
message = "Data not equal. Expected %d bytes, received %d."
639
self.fail(message % (len(response_data), self.test_data_len))
641
def test_defaults(self):
642
"""Verifies that the default arguments will read to EOF -- this
643
test verifies that any existing usages of pumpfile will not be broken
644
with this new version."""
645
# retrieve data using default (old) pumpfile method
646
from_file = file_utils.FakeReadFile(self.test_data)
648
osutils.pumpfile(from_file, to_file)
650
# report error if the data wasn't equal (we only report the size due
651
# to the length of the data)
652
response_data = to_file.getvalue()
653
if response_data != self.test_data:
654
message = "Data not equal. Expected %d bytes, received %d."
655
self.fail(message % (len(response_data), self.test_data_len))
657
def test_report_activity(self):
659
def log_activity(length, direction):
660
activity.append((length, direction))
661
from_file = StringIO(self.test_data)
663
osutils.pumpfile(from_file, to_file, buff_size=500,
664
report_activity=log_activity, direction='read')
665
self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
666
(36, 'read')], activity)
668
from_file = StringIO(self.test_data)
671
osutils.pumpfile(from_file, to_file, buff_size=500,
672
report_activity=log_activity, direction='write')
673
self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
674
(36, 'write')], activity)
676
# And with a limited amount of data
677
from_file = StringIO(self.test_data)
680
osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
681
report_activity=log_activity, direction='read')
682
self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
686
class TestPumpStringFile(tests.TestCase):
688
def test_empty(self):
690
osutils.pump_string_file("", output)
691
self.assertEqual("", output.getvalue())
693
def test_more_than_segment_size(self):
695
osutils.pump_string_file("123456789", output, 2)
696
self.assertEqual("123456789", output.getvalue())
698
def test_segment_size(self):
700
osutils.pump_string_file("12", output, 2)
701
self.assertEqual("12", output.getvalue())
703
def test_segment_size_multiple(self):
705
osutils.pump_string_file("1234", output, 2)
706
self.assertEqual("1234", output.getvalue())
709
class TestRelpath(tests.TestCase):
711
def test_simple_relpath(self):
712
cwd = osutils.getcwd()
713
subdir = cwd + '/subdir'
714
self.assertEqual('subdir', osutils.relpath(cwd, subdir))
716
def test_deep_relpath(self):
717
cwd = osutils.getcwd()
718
subdir = cwd + '/sub/subsubdir'
719
self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
721
def test_not_relative(self):
722
self.assertRaises(errors.PathNotChild,
723
osutils.relpath, 'C:/path', 'H:/path')
724
self.assertRaises(errors.PathNotChild,
725
osutils.relpath, 'C:/', 'H:/path')
728
class TestSafeUnicode(tests.TestCase):
246
730
def test_from_ascii_string(self):
247
731
self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
718
1350
result.append((dirdetail, new_dirblock))
719
1351
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
1353
def test__walkdirs_utf8_with_unicode_fs(self):
1354
"""UnicodeDirReader should be a safe fallback everywhere
724
1356
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 + '/',
1358
self.requireFeature(features.UnicodeFilenameFeature)
1359
# Use the unicode reader. TODO: split into driver-and-driven unit
1361
self._save_platform_info()
1362
osutils._selected_dir_reader = osutils.UnicodeDirReader()
1363
name0u = u'0file-\xb6'
1364
name1u = u'1dir-\u062c\u0648'
1365
name2u = u'2file-\u0633'
1369
name1u + '/' + name0u,
1370
name1u + '/' + name1u + '/',
1373
self.build_tree(tree)
1374
name0 = name0u.encode('utf8')
1375
name1 = name1u.encode('utf8')
1376
name2 = name2u.encode('utf8')
1378
# All of the abspaths should be in unicode, all of the relative paths
1380
expected_dirblocks = [
1382
[(name0, name0, 'file', './' + name0u),
1383
(name1, name1, 'directory', './' + name1u),
1384
(name2, name2, 'file', './' + name2u),
1387
((name1, './' + name1u),
1388
[(name1 + '/' + name0, name0, 'file', './' + name1u
1390
(name1 + '/' + name1, name1, 'directory', './' + name1u
1394
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1399
result = list(osutils._walkdirs_utf8('.'))
1400
self._filter_out_stat(result)
1401
self.assertEqual(expected_dirblocks, result)
1403
def test__walkdirs_utf8_win32readdir(self):
1404
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1405
self.requireFeature(features.UnicodeFilenameFeature)
1406
from bzrlib._walkdirs_win32 import Win32ReadDir
1407
self._save_platform_info()
1408
osutils._selected_dir_reader = Win32ReadDir()
1409
name0u = u'0file-\xb6'
1410
name1u = u'1dir-\u062c\u0648'
1411
name2u = u'2file-\u0633'
1415
name1u + '/' + name0u,
1416
name1u + '/' + name1u + '/',
1419
self.build_tree(tree)
1420
name0 = name0u.encode('utf8')
1421
name1 = name1u.encode('utf8')
1422
name2 = name2u.encode('utf8')
1424
# All of the abspaths should be in unicode, all of the relative paths
1426
expected_dirblocks = [
1428
[(name0, name0, 'file', './' + name0u),
1429
(name1, name1, 'directory', './' + name1u),
1430
(name2, name2, 'file', './' + name2u),
1433
((name1, './' + name1u),
1434
[(name1 + '/' + name0, name0, 'file', './' + name1u
1436
(name1 + '/' + name1, name1, 'directory', './' + name1u
1440
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1445
result = list(osutils._walkdirs_utf8(u'.'))
1446
self._filter_out_stat(result)
1447
self.assertEqual(expected_dirblocks, result)
1449
def assertStatIsCorrect(self, path, win32stat):
1450
os_stat = os.stat(path)
1451
self.assertEqual(os_stat.st_size, win32stat.st_size)
1452
self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
1453
self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
1454
self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
1455
self.assertEqual(os_stat.st_dev, win32stat.st_dev)
1456
self.assertEqual(os_stat.st_ino, win32stat.st_ino)
1457
self.assertEqual(os_stat.st_mode, win32stat.st_mode)
1459
def test__walkdirs_utf_win32_find_file_stat_file(self):
1460
"""make sure our Stat values are valid"""
1461
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1462
self.requireFeature(features.UnicodeFilenameFeature)
1463
from bzrlib._walkdirs_win32 import Win32ReadDir
1464
name0u = u'0file-\xb6'
1465
name0 = name0u.encode('utf8')
1466
self.build_tree([name0u])
1467
# I hate to sleep() here, but I'm trying to make the ctime different
1470
f = open(name0u, 'ab')
737
self.build_tree(tree)
739
raise TestSkipped('Could not represent Unicode chars'
740
' in current encoding.')
1472
f.write('just a small update')
1476
result = Win32ReadDir().read_dir('', u'.')
1478
self.assertEqual((name0, name0, 'file'), entry[:3])
1479
self.assertEqual(u'./' + name0u, entry[4])
1480
self.assertStatIsCorrect(entry[4], entry[3])
1481
self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
1483
def test__walkdirs_utf_win32_find_file_stat_directory(self):
1484
"""make sure our Stat values are valid"""
1485
self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1486
self.requireFeature(features.UnicodeFilenameFeature)
1487
from bzrlib._walkdirs_win32 import Win32ReadDir
1488
name0u = u'0dir-\u062c\u0648'
741
1489
name0 = name0u.encode('utf8')
742
name1 = name1u.encode('utf8')
743
name2 = name2u.encode('utf8')
1490
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)
1492
result = Win32ReadDir().read_dir('', u'.')
1494
self.assertEqual((name0, name0, 'directory'), entry[:3])
1495
self.assertEqual(u'./' + name0u, entry[4])
1496
self.assertStatIsCorrect(entry[4], entry[3])
770
1498
def assertPathCompare(self, path_less, path_greater):
771
1499
"""check that path_less and path_greater compare correctly."""
959
1672
old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
960
1673
self.assertEqual('foo', old)
961
1674
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)
1675
self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1678
class TestSizeShaFile(tests.TestCaseInTempDir):
1680
def test_sha_empty(self):
1681
self.build_tree_contents([('foo', '')])
1682
expected_sha = osutils.sha_string('')
1684
self.addCleanup(f.close)
1685
size, sha = osutils.size_sha_file(f)
1686
self.assertEqual(0, size)
1687
self.assertEqual(expected_sha, sha)
1689
def test_sha_mixed_endings(self):
1690
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1691
self.build_tree_contents([('foo', text)])
1692
expected_sha = osutils.sha_string(text)
1693
f = open('foo', 'rb')
1694
self.addCleanup(f.close)
1695
size, sha = osutils.size_sha_file(f)
1696
self.assertEqual(38, size)
1697
self.assertEqual(expected_sha, sha)
1700
class TestShaFileByName(tests.TestCaseInTempDir):
1702
def test_sha_empty(self):
1703
self.build_tree_contents([('foo', '')])
1704
expected_sha = osutils.sha_string('')
1705
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1707
def test_sha_mixed_endings(self):
1708
text = 'test\r\nwith\nall\rpossible line endings\r\n'
1709
self.build_tree_contents([('foo', text)])
1710
expected_sha = osutils.sha_string(text)
1711
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1714
class TestResourceLoading(tests.TestCaseInTempDir):
1716
def test_resource_string(self):
1717
# test resource in bzrlib
1718
text = osutils.resource_string('bzrlib', 'debug.py')
1719
self.assertContainsRe(text, "debug_flags = set()")
1720
# test resource under bzrlib
1721
text = osutils.resource_string('bzrlib.ui', 'text.py')
1722
self.assertContainsRe(text, "class TextUIFactory")
1723
# test unsupported package
1724
self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
1726
# test unknown resource
1727
self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
1730
class TestReCompile(tests.TestCase):
1732
def _deprecated_re_compile_checked(self, *args, **kwargs):
1733
return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1734
osutils.re_compile_checked, *args, **kwargs)
1736
def test_re_compile_checked(self):
1737
r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1738
self.assertTrue(r.match('aaaa'))
1739
self.assertTrue(r.match('aAaA'))
1741
def test_re_compile_checked_error(self):
1742
# like https://bugs.launchpad.net/bzr/+bug/251352
1744
# Due to possible test isolation error, re.compile is not lazy at
1745
# this point. We re-install lazy compile.
1746
lazy_regex.install_lazy_compile()
1747
err = self.assertRaises(
1748
errors.BzrCommandError,
1749
self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1751
'Invalid regular expression in test case: '
1752
'"*" nothing to repeat',
1756
class TestDirReader(tests.TestCaseInTempDir):
1758
scenarios = dir_reader_scenarios()
1761
_dir_reader_class = None
1762
_native_to_unicode = None
1765
tests.TestCaseInTempDir.setUp(self)
1766
self.overrideAttr(osutils,
1767
'_selected_dir_reader', self._dir_reader_class())
1769
def _get_ascii_tree(self):
1777
expected_dirblocks = [
1779
[('0file', '0file', 'file'),
1780
('1dir', '1dir', 'directory'),
1781
('2file', '2file', 'file'),
1784
(('1dir', './1dir'),
1785
[('1dir/0file', '0file', 'file'),
1786
('1dir/1dir', '1dir', 'directory'),
1789
(('1dir/1dir', './1dir/1dir'),
1794
return tree, expected_dirblocks
1796
def test_walk_cur_dir(self):
1797
tree, expected_dirblocks = self._get_ascii_tree()
1798
self.build_tree(tree)
1799
result = list(osutils._walkdirs_utf8('.'))
1800
# Filter out stat and abspath
1801
self.assertEqual(expected_dirblocks,
1802
[(dirinfo, [line[0:3] for line in block])
1803
for dirinfo, block in result])
1805
def test_walk_sub_dir(self):
1806
tree, expected_dirblocks = self._get_ascii_tree()
1807
self.build_tree(tree)
1808
# you can search a subdir only, with a supplied prefix.
1809
result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
1810
# Filter out stat and abspath
1811
self.assertEqual(expected_dirblocks[1:],
1812
[(dirinfo, [line[0:3] for line in block])
1813
for dirinfo, block in result])
1815
def _get_unicode_tree(self):
1816
name0u = u'0file-\xb6'
1817
name1u = u'1dir-\u062c\u0648'
1818
name2u = u'2file-\u0633'
1822
name1u + '/' + name0u,
1823
name1u + '/' + name1u + '/',
1826
name0 = name0u.encode('UTF-8')
1827
name1 = name1u.encode('UTF-8')
1828
name2 = name2u.encode('UTF-8')
1829
expected_dirblocks = [
1831
[(name0, name0, 'file', './' + name0u),
1832
(name1, name1, 'directory', './' + name1u),
1833
(name2, name2, 'file', './' + name2u),
1836
((name1, './' + name1u),
1837
[(name1 + '/' + name0, name0, 'file', './' + name1u
1839
(name1 + '/' + name1, name1, 'directory', './' + name1u
1843
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1848
return tree, expected_dirblocks
1850
def _filter_out(self, raw_dirblocks):
1851
"""Filter out a walkdirs_utf8 result.
1853
stat field is removed, all native paths are converted to unicode
1855
filtered_dirblocks = []
1856
for dirinfo, block in raw_dirblocks:
1857
dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
1860
details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
1861
filtered_dirblocks.append((dirinfo, details))
1862
return filtered_dirblocks
1864
def test_walk_unicode_tree(self):
1865
self.requireFeature(features.UnicodeFilenameFeature)
1866
tree, expected_dirblocks = self._get_unicode_tree()
1867
self.build_tree(tree)
1868
result = list(osutils._walkdirs_utf8('.'))
1869
self.assertEqual(expected_dirblocks, self._filter_out(result))
1871
def test_symlink(self):
1872
self.requireFeature(features.SymlinkFeature)
1873
self.requireFeature(features.UnicodeFilenameFeature)
1874
target = u'target\N{Euro Sign}'
1875
link_name = u'l\N{Euro Sign}nk'
1876
os.symlink(target, link_name)
1877
target_utf8 = target.encode('UTF-8')
1878
link_name_utf8 = link_name.encode('UTF-8')
1879
expected_dirblocks = [
1881
[(link_name_utf8, link_name_utf8,
1882
'symlink', './' + link_name),],
1884
result = list(osutils._walkdirs_utf8('.'))
1885
self.assertEqual(expected_dirblocks, self._filter_out(result))
1888
class TestReadLink(tests.TestCaseInTempDir):
1889
"""Exposes os.readlink() problems and the osutils solution.
1891
The only guarantee offered by os.readlink(), starting with 2.6, is that a
1892
unicode string will be returned if a unicode string is passed.
1894
But prior python versions failed to properly encode the passed unicode
1897
_test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
1900
super(tests.TestCaseInTempDir, self).setUp()
1901
self.link = u'l\N{Euro Sign}ink'
1902
self.target = u'targe\N{Euro Sign}t'
1903
os.symlink(self.target, self.link)
1905
def test_os_readlink_link_encoding(self):
1906
self.assertEquals(self.target, os.readlink(self.link))
1908
def test_os_readlink_link_decoding(self):
1909
self.assertEquals(self.target.encode(osutils._fs_enc),
1910
os.readlink(self.link.encode(osutils._fs_enc)))
1913
class TestConcurrency(tests.TestCase):
1916
super(TestConcurrency, self).setUp()
1917
self.overrideAttr(osutils, '_cached_local_concurrency')
1919
def test_local_concurrency(self):
1920
concurrency = osutils.local_concurrency()
1921
self.assertIsInstance(concurrency, int)
1923
def test_local_concurrency_environment_variable(self):
1924
self.overrideEnv('BZR_CONCURRENCY', '2')
1925
self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1926
self.overrideEnv('BZR_CONCURRENCY', '3')
1927
self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1928
self.overrideEnv('BZR_CONCURRENCY', 'foo')
1929
self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1931
def test_option_concurrency(self):
1932
self.overrideEnv('BZR_CONCURRENCY', '1')
1933
self.run_bzr('rocks --concurrency 42')
1934
# Command line overrides environment variable
1935
self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1936
self.assertEquals(42, osutils.local_concurrency(use_cache=False))
1939
class TestFailedToLoadExtension(tests.TestCase):
1941
def _try_loading(self):
1943
import bzrlib._fictional_extension_py
1944
except ImportError, e:
1945
osutils.failed_to_load_extension(e)
1949
super(TestFailedToLoadExtension, self).setUp()
1950
self.overrideAttr(osutils, '_extension_load_failures', [])
1952
def test_failure_to_load(self):
1954
self.assertLength(1, osutils._extension_load_failures)
1955
self.assertEquals(osutils._extension_load_failures[0],
1956
"No module named _fictional_extension_py")
1958
def test_report_extension_load_failures_no_warning(self):
1959
self.assertTrue(self._try_loading())
1960
warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
1961
# it used to give a Python warning; it no longer does
1962
self.assertLength(0, warnings)
1964
def test_report_extension_load_failures_message(self):
1966
trace.push_log_file(log)
1967
self.assertTrue(self._try_loading())
1968
osutils.report_extension_load_failures()
1969
self.assertContainsRe(
1971
r"bzr: warning: some compiled extensions could not be loaded; "
1972
"see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
1976
class TestTerminalWidth(tests.TestCase):
1979
tests.TestCase.setUp(self)
1980
self._orig_terminal_size_state = osutils._terminal_size_state
1981
self._orig_first_terminal_size = osutils._first_terminal_size
1982
self.addCleanup(self.restore_osutils_globals)
1983
osutils._terminal_size_state = 'no_data'
1984
osutils._first_terminal_size = None
1986
def restore_osutils_globals(self):
1987
osutils._terminal_size_state = self._orig_terminal_size_state
1988
osutils._first_terminal_size = self._orig_first_terminal_size
1990
def replace_stdout(self, new):
1991
self.overrideAttr(sys, 'stdout', new)
1993
def replace__terminal_size(self, new):
1994
self.overrideAttr(osutils, '_terminal_size', new)
1996
def set_fake_tty(self):
1998
class I_am_a_tty(object):
2002
self.replace_stdout(I_am_a_tty())
2004
def test_default_values(self):
2005
self.assertEqual(80, osutils.default_terminal_width)
2007
def test_defaults_to_BZR_COLUMNS(self):
2008
# BZR_COLUMNS is set by the test framework
2009
self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
2010
self.overrideEnv('BZR_COLUMNS', '12')
2011
self.assertEqual(12, osutils.terminal_width())
2013
def test_BZR_COLUMNS_0_no_limit(self):
2014
self.overrideEnv('BZR_COLUMNS', '0')
2015
self.assertEqual(None, osutils.terminal_width())
2017
def test_falls_back_to_COLUMNS(self):
2018
self.overrideEnv('BZR_COLUMNS', None)
2019
self.assertNotEqual('42', os.environ['COLUMNS'])
2021
self.overrideEnv('COLUMNS', '42')
2022
self.assertEqual(42, osutils.terminal_width())
2024
def test_tty_default_without_columns(self):
2025
self.overrideEnv('BZR_COLUMNS', None)
2026
self.overrideEnv('COLUMNS', None)
2028
def terminal_size(w, h):
2032
# We need to override the osutils definition as it depends on the
2033
# running environment that we can't control (PQM running without a
2034
# controlling terminal is one example).
2035
self.replace__terminal_size(terminal_size)
2036
self.assertEqual(42, osutils.terminal_width())
2038
def test_non_tty_default_without_columns(self):
2039
self.overrideEnv('BZR_COLUMNS', None)
2040
self.overrideEnv('COLUMNS', None)
2041
self.replace_stdout(None)
2042
self.assertEqual(None, osutils.terminal_width())
2044
def test_no_TIOCGWINSZ(self):
2045
self.requireFeature(term_ios_feature)
2046
termios = term_ios_feature.module
2047
# bug 63539 is about a termios without TIOCGWINSZ attribute
2049
orig = termios.TIOCGWINSZ
2050
except AttributeError:
2051
# We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
2054
self.overrideAttr(termios, 'TIOCGWINSZ')
2055
del termios.TIOCGWINSZ
2056
self.overrideEnv('BZR_COLUMNS', None)
2057
self.overrideEnv('COLUMNS', None)
2058
# Whatever the result is, if we don't raise an exception, it's ok.
2059
osutils.terminal_width()
2062
class TestCreationOps(tests.TestCaseInTempDir):
2063
_test_needs_features = [features.chown_feature]
2066
tests.TestCaseInTempDir.setUp(self)
2067
self.overrideAttr(os, 'chown', self._dummy_chown)
2069
# params set by call to _dummy_chown
2070
self.path = self.uid = self.gid = None
2072
def _dummy_chown(self, path, uid, gid):
2073
self.path, self.uid, self.gid = path, uid, gid
2075
def test_copy_ownership_from_path(self):
2076
"""copy_ownership_from_path test with specified src."""
2078
f = open('test_file', 'wt')
2079
osutils.copy_ownership_from_path('test_file', ownsrc)
2082
self.assertEquals(self.path, 'test_file')
2083
self.assertEquals(self.uid, s.st_uid)
2084
self.assertEquals(self.gid, s.st_gid)
2086
def test_copy_ownership_nonesrc(self):
2087
"""copy_ownership_from_path test with src=None."""
2088
f = open('test_file', 'wt')
2089
# should use parent dir for permissions
2090
osutils.copy_ownership_from_path('test_file')
2093
self.assertEquals(self.path, 'test_file')
2094
self.assertEquals(self.uid, s.st_uid)
2095
self.assertEquals(self.gid, s.st_gid)
2098
class TestPathFromEnviron(tests.TestCase):
2100
def test_is_unicode(self):
2101
self.overrideEnv('BZR_TEST_PATH', './anywhere at all/')
2102
path = osutils.path_from_environ('BZR_TEST_PATH')
2103
self.assertIsInstance(path, unicode)
2104
self.assertEqual(u'./anywhere at all/', path)
2106
def test_posix_path_env_ascii(self):
2107
self.overrideEnv('BZR_TEST_PATH', '/tmp')
2108
home = osutils._posix_path_from_environ('BZR_TEST_PATH')
2109
self.assertIsInstance(home, unicode)
2110
self.assertEqual(u'/tmp', home)
2112
def test_posix_path_env_unicode(self):
2113
self.requireFeature(features.ByteStringNamedFilesystem)
2114
self.overrideEnv('BZR_TEST_PATH', '/home/\xa7test')
2115
self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
2116
self.assertEqual(u'/home/\xa7test',
2117
osutils._posix_path_from_environ('BZR_TEST_PATH'))
2118
osutils._fs_enc = "iso8859-5"
2119
self.assertEqual(u'/home/\u0407test',
2120
osutils._posix_path_from_environ('BZR_TEST_PATH'))
2121
osutils._fs_enc = "utf-8"
2122
self.assertRaises(errors.BadFilenameEncoding,
2123
osutils._posix_path_from_environ, 'BZR_TEST_PATH')
2126
class TestGetHomeDir(tests.TestCase):
2128
def test_is_unicode(self):
2129
home = osutils._get_home_dir()
2130
self.assertIsInstance(home, unicode)
2132
def test_posix_homeless(self):
2133
self.overrideEnv('HOME', None)
2134
home = osutils._get_home_dir()
2135
self.assertIsInstance(home, unicode)
2137
def test_posix_home_ascii(self):
2138
self.overrideEnv('HOME', '/home/test')
2139
home = osutils._posix_get_home_dir()
2140
self.assertIsInstance(home, unicode)
2141
self.assertEqual(u'/home/test', home)
2143
def test_posix_home_unicode(self):
2144
self.requireFeature(features.ByteStringNamedFilesystem)
2145
self.overrideEnv('HOME', '/home/\xa7test')
2146
self.overrideAttr(osutils, "_fs_enc", "iso8859-1")
2147
self.assertEqual(u'/home/\xa7test', osutils._posix_get_home_dir())
2148
osutils._fs_enc = "iso8859-5"
2149
self.assertEqual(u'/home/\u0407test', osutils._posix_get_home_dir())
2150
osutils._fs_enc = "utf-8"
2151
self.assertRaises(errors.BadFilenameEncoding,
2152
osutils._posix_get_home_dir)
2155
class TestGetuserUnicode(tests.TestCase):
2157
def test_is_unicode(self):
2158
user = osutils.getuser_unicode()
2159
self.assertIsInstance(user, unicode)
2161
def envvar_to_override(self):
2162
if sys.platform == "win32":
2163
# Disable use of platform calls on windows so envvar is used
2164
self.overrideAttr(win32utils, 'has_ctypes', False)
2165
return 'USERNAME' # only variable used on windows
2166
return 'LOGNAME' # first variable checked by getpass.getuser()
2168
def test_ascii_user(self):
2169
self.overrideEnv(self.envvar_to_override(), 'jrandom')
2170
self.assertEqual(u'jrandom', osutils.getuser_unicode())
2172
def test_unicode_user(self):
2173
ue = osutils.get_user_encoding()
2174
uni_val, env_val = tests.probe_unicode_in_user_encoding()
2176
raise tests.TestSkipped(
2177
'Cannot find a unicode character that works in encoding %s'
2178
% (osutils.get_user_encoding(),))
2179
uni_username = u'jrandom' + uni_val
2180
encoded_username = uni_username.encode(ue)
2181
self.overrideEnv(self.envvar_to_override(), encoded_username)
2182
self.assertEqual(uni_username, osutils.getuser_unicode())
2185
class TestBackupNames(tests.TestCase):
2188
super(TestBackupNames, self).setUp()
2191
def backup_exists(self, name):
2192
return name in self.backups
2194
def available_backup_name(self, name):
2195
backup_name = osutils.available_backup_name(name, self.backup_exists)
2196
self.backups.append(backup_name)
2199
def assertBackupName(self, expected, name):
2200
self.assertEqual(expected, self.available_backup_name(name))
2202
def test_empty(self):
2203
self.assertBackupName('file.~1~', 'file')
2205
def test_existing(self):
2206
self.available_backup_name('file')
2207
self.available_backup_name('file')
2208
self.assertBackupName('file.~3~', 'file')
2209
# Empty slots are found, this is not a strict requirement and may be
2210
# revisited if we test against all implementations.
2211
self.backups.remove('file.~2~')
2212
self.assertBackupName('file.~2~', 'file')
2215
class TestFindExecutableInPath(tests.TestCase):
2217
def test_windows(self):
2218
if sys.platform != 'win32':
2219
raise tests.TestSkipped('test requires win32')
2220
self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
2222
osutils.find_executable_on_path('explorer.exe') is not None)
2224
osutils.find_executable_on_path('EXPLORER.EXE') is not None)
2226
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2227
self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
2229
def test_windows_app_path(self):
2230
if sys.platform != 'win32':
2231
raise tests.TestSkipped('test requires win32')
2232
# Override PATH env var so that exe can only be found on App Path
2233
self.overrideEnv('PATH', '')
2234
# Internt Explorer is always registered in the App Path
2235
self.assertTrue(osutils.find_executable_on_path('iexplore') is not None)
2237
def test_other(self):
2238
if sys.platform == 'win32':
2239
raise tests.TestSkipped('test requires non-win32')
2240
self.assertTrue(osutils.find_executable_on_path('sh') is not None)
2242
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2245
class TestEnvironmentErrors(tests.TestCase):
2246
"""Test handling of environmental errors"""
2248
def test_is_oserror(self):
2249
self.assertTrue(osutils.is_environment_error(
2250
OSError(errno.EINVAL, "Invalid parameter")))
2252
def test_is_ioerror(self):
2253
self.assertTrue(osutils.is_environment_error(
2254
IOError(errno.EINVAL, "Invalid parameter")))
2256
def test_is_socket_error(self):
2257
self.assertTrue(osutils.is_environment_error(
2258
socket.error(errno.EINVAL, "Invalid parameter")))
2260
def test_is_select_error(self):
2261
self.assertTrue(osutils.is_environment_error(
2262
select.error(errno.EINVAL, "Invalid parameter")))
2264
def test_is_pywintypes_error(self):
2265
self.requireFeature(features.pywintypes)
2267
self.assertTrue(osutils.is_environment_error(
2268
pywintypes.error(errno.EINVAL, "Invalid parameter", "Caller")))
added
removed
bzrlib/tests/test_osutils.py
