57
53
UTF8DirReaderFeature = _UTF8DirReaderFeature()
59
term_ios_feature = tests.ModuleAvailableFeature('termios')
62
def _already_unicode(s):
66
def _utf8_to_unicode(s):
67
return s.decode('UTF-8')
70
def dir_reader_scenarios():
71
# For each dir reader we define:
73
# - native_to_unicode: a function converting the native_abspath as returned
74
# by DirReader.read_dir to its unicode representation
76
# UnicodeDirReader is the fallback, it should be tested on all platforms.
77
scenarios = [('unicode',
78
dict(_dir_reader_class=osutils.UnicodeDirReader,
79
_native_to_unicode=_already_unicode))]
80
# Some DirReaders are platform specific and even there they may not be
82
if UTF8DirReaderFeature.available():
83
from bzrlib import _readdir_pyx
84
scenarios.append(('utf8',
85
dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
86
_native_to_unicode=_utf8_to_unicode)))
88
if test__walkdirs_win32.win32_readdir_feature.available():
90
from bzrlib import _walkdirs_win32
93
dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
94
_native_to_unicode=_already_unicode)))
100
load_tests = load_tests_apply_scenarios
103
class TestContainsWhitespace(tests.TestCase):
56
class TestOSUtils(tests.TestCaseInTempDir):
105
58
def test_contains_whitespace(self):
106
self.assertTrue(osutils.contains_whitespace(u' '))
107
self.assertTrue(osutils.contains_whitespace(u'hello there'))
108
self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
109
self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
110
self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
111
self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
59
self.failUnless(osutils.contains_whitespace(u' '))
60
self.failUnless(osutils.contains_whitespace(u'hello there'))
61
self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
62
self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
63
self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
64
self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
113
66
# \xa0 is "Non-breaking-space" which on some python locales thinks it
114
67
# is whitespace, but we do not.
115
self.assertFalse(osutils.contains_whitespace(u''))
116
self.assertFalse(osutils.contains_whitespace(u'hellothere'))
117
self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
120
class TestRename(tests.TestCaseInTempDir):
122
def create_file(self, filename, content):
123
f = open(filename, 'wb')
129
def _fancy_rename(self, a, b):
130
osutils.fancy_rename(a, b, rename_func=os.rename,
131
unlink_func=os.unlink)
68
self.failIf(osutils.contains_whitespace(u''))
69
self.failIf(osutils.contains_whitespace(u'hellothere'))
70
self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
133
72
def test_fancy_rename(self):
134
73
# This should work everywhere
135
self.create_file('a', 'something in a\n')
136
self._fancy_rename('a', 'b')
137
self.assertPathDoesNotExist('a')
138
self.assertPathExists('b')
75
osutils.fancy_rename(a, b,
76
rename_func=os.rename,
77
unlink_func=os.unlink)
79
open('a', 'wb').write('something in a\n')
81
self.failIfExists('a')
82
self.failUnlessExists('b')
139
83
self.check_file_contents('b', 'something in a\n')
141
self.create_file('a', 'new something in a\n')
142
self._fancy_rename('b', 'a')
85
open('a', 'wb').write('new something in a\n')
144
88
self.check_file_contents('a', 'something in a\n')
146
def test_fancy_rename_fails_source_missing(self):
147
# An exception should be raised, and the target should be left in place
148
self.create_file('target', 'data in target\n')
149
self.assertRaises((IOError, OSError), self._fancy_rename,
150
'missingsource', 'target')
151
self.assertPathExists('target')
152
self.check_file_contents('target', 'data in target\n')
154
def test_fancy_rename_fails_if_source_and_target_missing(self):
155
self.assertRaises((IOError, OSError), self._fancy_rename,
156
'missingsource', 'missingtarget')
158
90
def test_rename(self):
159
91
# Rename should be semi-atomic on all platforms
160
self.create_file('a', 'something in a\n')
92
open('a', 'wb').write('something in a\n')
161
93
osutils.rename('a', 'b')
162
self.assertPathDoesNotExist('a')
163
self.assertPathExists('b')
94
self.failIfExists('a')
95
self.failUnlessExists('b')
164
96
self.check_file_contents('b', 'something in a\n')
166
self.create_file('a', 'new something in a\n')
98
open('a', 'wb').write('new something in a\n')
167
99
osutils.rename('b', 'a')
169
101
self.check_file_contents('a', 'something in a\n')
487
342
def test_canonical_relpath_simple(self):
488
343
f = file('MixedCaseName', 'w')
490
actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
491
self.assertEqual('work/MixedCaseName', actual)
345
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
346
real_base_dir = osutils.realpath(self.test_base_dir)
347
actual = osutils.canonical_relpath(real_base_dir, 'mixedcasename')
348
self.failUnlessEqual('work/MixedCaseName', actual)
493
350
def test_canonical_relpath_missing_tail(self):
494
351
os.mkdir('MixedCaseParent')
495
actual = osutils.canonical_relpath(self.test_base_dir,
352
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
353
real_base_dir = osutils.realpath(self.test_base_dir)
354
actual = osutils.canonical_relpath(real_base_dir,
496
355
'mixedcaseparent/nochild')
497
self.assertEqual('work/MixedCaseParent/nochild', actual)
500
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
502
def assertRelpath(self, expected, base, path):
503
actual = osutils._cicp_canonical_relpath(base, path)
504
self.assertEqual(expected, actual)
506
def test_simple(self):
507
self.build_tree(['MixedCaseName'])
508
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
509
self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
511
def test_subdir_missing_tail(self):
512
self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
513
base = osutils.realpath(self.get_transport('.').local_abspath('.'))
514
self.assertRelpath('MixedCaseParent/a_child', base,
515
'MixedCaseParent/a_child')
516
self.assertRelpath('MixedCaseParent/a_child', base,
517
'MixedCaseParent/A_Child')
518
self.assertRelpath('MixedCaseParent/not_child', base,
519
'MixedCaseParent/not_child')
521
def test_at_root_slash(self):
522
# We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
524
if osutils.MIN_ABS_PATHLENGTH > 1:
525
raise tests.TestSkipped('relpath requires %d chars'
526
% osutils.MIN_ABS_PATHLENGTH)
527
self.assertRelpath('foo', '/', '/foo')
529
def test_at_root_drive(self):
530
if sys.platform != 'win32':
531
raise tests.TestNotApplicable('we can only test drive-letter relative'
532
' paths on Windows where we have drive'
535
# The specific issue is that when at the root of a drive, 'abspath'
536
# returns "C:/" or just "/". However, the code assumes that abspath
537
# always returns something like "C:/foo" or "/foo" (no trailing slash).
538
self.assertRelpath('foo', 'C:/', 'C:/foo')
539
self.assertRelpath('foo', 'X:/', 'X:/foo')
540
self.assertRelpath('foo', 'X:/', 'X://foo')
356
self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
543
359
class TestPumpFile(tests.TestCase):
1724
1497
class TestReCompile(tests.TestCase):
1726
def _deprecated_re_compile_checked(self, *args, **kwargs):
1727
return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1728
osutils.re_compile_checked, *args, **kwargs)
1730
1499
def test_re_compile_checked(self):
1731
r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1500
r = osutils.re_compile_checked(r'A*', re.IGNORECASE)
1732
1501
self.assertTrue(r.match('aaaa'))
1733
1502
self.assertTrue(r.match('aAaA'))
1735
1504
def test_re_compile_checked_error(self):
1736
1505
# like https://bugs.launchpad.net/bzr/+bug/251352
1738
# Due to possible test isolation error, re.compile is not lazy at
1739
# this point. We re-install lazy compile.
1740
lazy_regex.install_lazy_compile()
1741
1506
err = self.assertRaises(
1742
1507
errors.BzrCommandError,
1743
self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1508
osutils.re_compile_checked, '*', re.IGNORECASE, 'test case')
1744
1509
self.assertEqual(
1745
'Invalid regular expression in test case: '
1746
'"*" nothing to repeat',
1510
"Invalid regular expression in test case: '*': "
1511
"nothing to repeat",
1750
class TestDirReader(tests.TestCaseInTempDir):
1752
scenarios = dir_reader_scenarios()
1755
_dir_reader_class = None
1756
_native_to_unicode = None
1759
tests.TestCaseInTempDir.setUp(self)
1760
self.overrideAttr(osutils,
1761
'_selected_dir_reader', self._dir_reader_class())
1763
def _get_ascii_tree(self):
1771
expected_dirblocks = [
1773
[('0file', '0file', 'file'),
1774
('1dir', '1dir', 'directory'),
1775
('2file', '2file', 'file'),
1778
(('1dir', './1dir'),
1779
[('1dir/0file', '0file', 'file'),
1780
('1dir/1dir', '1dir', 'directory'),
1783
(('1dir/1dir', './1dir/1dir'),
1788
return tree, expected_dirblocks
1790
def test_walk_cur_dir(self):
1791
tree, expected_dirblocks = self._get_ascii_tree()
1792
self.build_tree(tree)
1793
result = list(osutils._walkdirs_utf8('.'))
1794
# Filter out stat and abspath
1795
self.assertEqual(expected_dirblocks,
1796
[(dirinfo, [line[0:3] for line in block])
1797
for dirinfo, block in result])
1799
def test_walk_sub_dir(self):
1800
tree, expected_dirblocks = self._get_ascii_tree()
1801
self.build_tree(tree)
1802
# you can search a subdir only, with a supplied prefix.
1803
result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
1804
# Filter out stat and abspath
1805
self.assertEqual(expected_dirblocks[1:],
1806
[(dirinfo, [line[0:3] for line in block])
1807
for dirinfo, block in result])
1809
def _get_unicode_tree(self):
1810
name0u = u'0file-\xb6'
1811
name1u = u'1dir-\u062c\u0648'
1812
name2u = u'2file-\u0633'
1816
name1u + '/' + name0u,
1817
name1u + '/' + name1u + '/',
1820
name0 = name0u.encode('UTF-8')
1821
name1 = name1u.encode('UTF-8')
1822
name2 = name2u.encode('UTF-8')
1823
expected_dirblocks = [
1825
[(name0, name0, 'file', './' + name0u),
1826
(name1, name1, 'directory', './' + name1u),
1827
(name2, name2, 'file', './' + name2u),
1830
((name1, './' + name1u),
1831
[(name1 + '/' + name0, name0, 'file', './' + name1u
1833
(name1 + '/' + name1, name1, 'directory', './' + name1u
1837
((name1 + '/' + name1, './' + name1u + '/' + name1u),
1842
return tree, expected_dirblocks
1844
def _filter_out(self, raw_dirblocks):
1845
"""Filter out a walkdirs_utf8 result.
1847
stat field is removed, all native paths are converted to unicode
1849
filtered_dirblocks = []
1850
for dirinfo, block in raw_dirblocks:
1851
dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
1854
details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
1855
filtered_dirblocks.append((dirinfo, details))
1856
return filtered_dirblocks
1858
def test_walk_unicode_tree(self):
1859
self.requireFeature(tests.UnicodeFilenameFeature)
1860
tree, expected_dirblocks = self._get_unicode_tree()
1861
self.build_tree(tree)
1862
result = list(osutils._walkdirs_utf8('.'))
1863
self.assertEqual(expected_dirblocks, self._filter_out(result))
1865
def test_symlink(self):
1866
self.requireFeature(tests.SymlinkFeature)
1867
self.requireFeature(tests.UnicodeFilenameFeature)
1868
target = u'target\N{Euro Sign}'
1869
link_name = u'l\N{Euro Sign}nk'
1870
os.symlink(target, link_name)
1871
target_utf8 = target.encode('UTF-8')
1872
link_name_utf8 = link_name.encode('UTF-8')
1873
expected_dirblocks = [
1875
[(link_name_utf8, link_name_utf8,
1876
'symlink', './' + link_name),],
1878
result = list(osutils._walkdirs_utf8('.'))
1879
self.assertEqual(expected_dirblocks, self._filter_out(result))
1882
class TestReadLink(tests.TestCaseInTempDir):
1883
"""Exposes os.readlink() problems and the osutils solution.
1885
The only guarantee offered by os.readlink(), starting with 2.6, is that a
1886
unicode string will be returned if a unicode string is passed.
1888
But prior python versions failed to properly encode the passed unicode
1891
_test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
1894
super(tests.TestCaseInTempDir, self).setUp()
1895
self.link = u'l\N{Euro Sign}ink'
1896
self.target = u'targe\N{Euro Sign}t'
1897
os.symlink(self.target, self.link)
1899
def test_os_readlink_link_encoding(self):
1900
self.assertEquals(self.target, os.readlink(self.link))
1902
def test_os_readlink_link_decoding(self):
1903
self.assertEquals(self.target.encode(osutils._fs_enc),
1904
os.readlink(self.link.encode(osutils._fs_enc)))
1907
class TestConcurrency(tests.TestCase):
1910
super(TestConcurrency, self).setUp()
1911
self.overrideAttr(osutils, '_cached_local_concurrency')
1913
def test_local_concurrency(self):
1914
concurrency = osutils.local_concurrency()
1915
self.assertIsInstance(concurrency, int)
1917
def test_local_concurrency_environment_variable(self):
1918
self.overrideEnv('BZR_CONCURRENCY', '2')
1919
self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1920
self.overrideEnv('BZR_CONCURRENCY', '3')
1921
self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1922
self.overrideEnv('BZR_CONCURRENCY', 'foo')
1923
self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1925
def test_option_concurrency(self):
1926
self.overrideEnv('BZR_CONCURRENCY', '1')
1927
self.run_bzr('rocks --concurrency 42')
1928
# Command line overrides environment variable
1929
self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1930
self.assertEquals(42, osutils.local_concurrency(use_cache=False))
1933
class TestFailedToLoadExtension(tests.TestCase):
1935
def _try_loading(self):
1937
import bzrlib._fictional_extension_py
1938
except ImportError, e:
1939
osutils.failed_to_load_extension(e)
1943
super(TestFailedToLoadExtension, self).setUp()
1944
self.overrideAttr(osutils, '_extension_load_failures', [])
1946
def test_failure_to_load(self):
1948
self.assertLength(1, osutils._extension_load_failures)
1949
self.assertEquals(osutils._extension_load_failures[0],
1950
"No module named _fictional_extension_py")
1952
def test_report_extension_load_failures_no_warning(self):
1953
self.assertTrue(self._try_loading())
1954
warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
1955
# it used to give a Python warning; it no longer does
1956
self.assertLength(0, warnings)
1958
def test_report_extension_load_failures_message(self):
1960
trace.push_log_file(log)
1961
self.assertTrue(self._try_loading())
1962
osutils.report_extension_load_failures()
1963
self.assertContainsRe(
1965
r"bzr: warning: some compiled extensions could not be loaded; "
1966
"see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
1970
class TestTerminalWidth(tests.TestCase):
1973
tests.TestCase.setUp(self)
1974
self._orig_terminal_size_state = osutils._terminal_size_state
1975
self._orig_first_terminal_size = osutils._first_terminal_size
1976
self.addCleanup(self.restore_osutils_globals)
1977
osutils._terminal_size_state = 'no_data'
1978
osutils._first_terminal_size = None
1980
def restore_osutils_globals(self):
1981
osutils._terminal_size_state = self._orig_terminal_size_state
1982
osutils._first_terminal_size = self._orig_first_terminal_size
1984
def replace_stdout(self, new):
1985
self.overrideAttr(sys, 'stdout', new)
1987
def replace__terminal_size(self, new):
1988
self.overrideAttr(osutils, '_terminal_size', new)
1990
def set_fake_tty(self):
1992
class I_am_a_tty(object):
1996
self.replace_stdout(I_am_a_tty())
1998
def test_default_values(self):
1999
self.assertEqual(80, osutils.default_terminal_width)
2001
def test_defaults_to_BZR_COLUMNS(self):
2002
# BZR_COLUMNS is set by the test framework
2003
self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
2004
self.overrideEnv('BZR_COLUMNS', '12')
2005
self.assertEqual(12, osutils.terminal_width())
2007
def test_BZR_COLUMNS_0_no_limit(self):
2008
self.overrideEnv('BZR_COLUMNS', '0')
2009
self.assertEqual(None, osutils.terminal_width())
2011
def test_falls_back_to_COLUMNS(self):
2012
self.overrideEnv('BZR_COLUMNS', None)
2013
self.assertNotEqual('42', os.environ['COLUMNS'])
2015
self.overrideEnv('COLUMNS', '42')
2016
self.assertEqual(42, osutils.terminal_width())
2018
def test_tty_default_without_columns(self):
2019
self.overrideEnv('BZR_COLUMNS', None)
2020
self.overrideEnv('COLUMNS', None)
2022
def terminal_size(w, h):
2026
# We need to override the osutils definition as it depends on the
2027
# running environment that we can't control (PQM running without a
2028
# controlling terminal is one example).
2029
self.replace__terminal_size(terminal_size)
2030
self.assertEqual(42, osutils.terminal_width())
2032
def test_non_tty_default_without_columns(self):
2033
self.overrideEnv('BZR_COLUMNS', None)
2034
self.overrideEnv('COLUMNS', None)
2035
self.replace_stdout(None)
2036
self.assertEqual(None, osutils.terminal_width())
2038
def test_no_TIOCGWINSZ(self):
2039
self.requireFeature(term_ios_feature)
2040
termios = term_ios_feature.module
2041
# bug 63539 is about a termios without TIOCGWINSZ attribute
2043
orig = termios.TIOCGWINSZ
2044
except AttributeError:
2045
# We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
2048
self.overrideAttr(termios, 'TIOCGWINSZ')
2049
del termios.TIOCGWINSZ
2050
self.overrideEnv('BZR_COLUMNS', None)
2051
self.overrideEnv('COLUMNS', None)
2052
# Whatever the result is, if we don't raise an exception, it's ok.
2053
osutils.terminal_width()
2056
class TestCreationOps(tests.TestCaseInTempDir):
2057
_test_needs_features = [features.chown_feature]
2060
tests.TestCaseInTempDir.setUp(self)
2061
self.overrideAttr(os, 'chown', self._dummy_chown)
2063
# params set by call to _dummy_chown
2064
self.path = self.uid = self.gid = None
2066
def _dummy_chown(self, path, uid, gid):
2067
self.path, self.uid, self.gid = path, uid, gid
2069
def test_copy_ownership_from_path(self):
2070
"""copy_ownership_from_path test with specified src."""
2072
f = open('test_file', 'wt')
2073
osutils.copy_ownership_from_path('test_file', ownsrc)
2076
self.assertEquals(self.path, 'test_file')
2077
self.assertEquals(self.uid, s.st_uid)
2078
self.assertEquals(self.gid, s.st_gid)
2080
def test_copy_ownership_nonesrc(self):
2081
"""copy_ownership_from_path test with src=None."""
2082
f = open('test_file', 'wt')
2083
# should use parent dir for permissions
2084
osutils.copy_ownership_from_path('test_file')
2087
self.assertEquals(self.path, 'test_file')
2088
self.assertEquals(self.uid, s.st_uid)
2089
self.assertEquals(self.gid, s.st_gid)
2092
class TestGetuserUnicode(tests.TestCase):
2094
def test_ascii_user(self):
2095
self.overrideEnv('LOGNAME', 'jrandom')
2096
self.assertEqual(u'jrandom', osutils.getuser_unicode())
2098
def test_unicode_user(self):
2099
ue = osutils.get_user_encoding()
2100
uni_val, env_val = tests.probe_unicode_in_user_encoding()
2102
raise tests.TestSkipped(
2103
'Cannot find a unicode character that works in encoding %s'
2104
% (osutils.get_user_encoding(),))
2105
uni_username = u'jrandom' + uni_val
2106
encoded_username = uni_username.encode(ue)
2107
self.overrideEnv('LOGNAME', encoded_username)
2108
self.assertEqual(uni_username, osutils.getuser_unicode())
2109
self.overrideEnv('LOGNAME', u'jrandom\xb6'.encode(ue))
2110
self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
2112
def test_no_username_bug_660174(self):
2113
self.requireFeature(features.win32_feature)
2114
for name in ('LOGNAME', 'USER', 'LNAME', 'USERNAME'):
2115
self.overrideEnv(name, None)
2116
self.assertEqual(u'UNKNOWN', osutils.getuser_unicode())
2119
class TestBackupNames(tests.TestCase):
2122
super(TestBackupNames, self).setUp()
2125
def backup_exists(self, name):
2126
return name in self.backups
2128
def available_backup_name(self, name):
2129
backup_name = osutils.available_backup_name(name, self.backup_exists)
2130
self.backups.append(backup_name)
2133
def assertBackupName(self, expected, name):
2134
self.assertEqual(expected, self.available_backup_name(name))
2136
def test_empty(self):
2137
self.assertBackupName('file.~1~', 'file')
2139
def test_existing(self):
2140
self.available_backup_name('file')
2141
self.available_backup_name('file')
2142
self.assertBackupName('file.~3~', 'file')
2143
# Empty slots are found, this is not a strict requirement and may be
2144
# revisited if we test against all implementations.
2145
self.backups.remove('file.~2~')
2146
self.assertBackupName('file.~2~', 'file')
2149
class TestFindExecutableInPath(tests.TestCase):
2151
def test_windows(self):
2152
if sys.platform != 'win32':
2153
raise tests.TestSkipped('test requires win32')
2154
self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
2156
osutils.find_executable_on_path('explorer.exe') is not None)
2158
osutils.find_executable_on_path('EXPLORER.EXE') is not None)
2160
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2161
self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
2163
def test_other(self):
2164
if sys.platform == 'win32':
2165
raise tests.TestSkipped('test requires non-win32')
2166
self.assertTrue(osutils.find_executable_on_path('sh') is not None)
2168
osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
added
removed
bzrlib/tests/test_osutils.py
