← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: John Arbash Meinel
  • Date: 2011-05-11 11:35:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5851.
  • Revision ID: john@arbash-meinel.com-20110511113528-qepibuwxicjrbb2h
Break compatibility with python <2.6.

This includes auditing the code for places where we were doing
explicit 'sys.version' checks and removing them as appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_osutils.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
21
21
import os
22
22
import re
23
23
import socket
24
 
import stat
25
24
import sys
26
25
import time
27
26
 
28
27
from bzrlib import (
29
28
    errors,
 
29
    lazy_regex,
30
30
    osutils,
 
31
    symbol_versioning,
31
32
    tests,
32
33
    trace,
33
34
    win32utils,
37
38
    file_utils,
38
39
    test__walkdirs_win32,
39
40
    )
 
41
from bzrlib.tests.scenarios import load_tests_apply_scenarios
40
42
 
41
43
 
42
44
class _UTF8DirReaderFeature(tests.Feature):
95
97
    return scenarios
96
98
 
97
99
 
98
 
def load_tests(basic_tests, module, loader):
99
 
    suite = loader.suiteClass()
100
 
    dir_reader_tests, remaining_tests = tests.split_suite_by_condition(
101
 
        basic_tests, tests.condition_isinstance(TestDirReader))
102
 
    tests.multiply_tests(dir_reader_tests, dir_reader_scenarios(), suite)
103
 
    suite.addTest(remaining_tests)
104
 
    return suite
 
100
load_tests = load_tests_apply_scenarios
105
101
 
106
102
 
107
103
class TestContainsWhitespace(tests.TestCase):
108
104
 
109
105
    def test_contains_whitespace(self):
110
 
        self.failUnless(osutils.contains_whitespace(u' '))
111
 
        self.failUnless(osutils.contains_whitespace(u'hello there'))
112
 
        self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
113
 
        self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
114
 
        self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
115
 
        self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
 
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'))
116
112
 
117
113
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
118
114
        # is whitespace, but we do not.
119
 
        self.failIf(osutils.contains_whitespace(u''))
120
 
        self.failIf(osutils.contains_whitespace(u'hellothere'))
121
 
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
 
115
        self.assertFalse(osutils.contains_whitespace(u''))
 
116
        self.assertFalse(osutils.contains_whitespace(u'hellothere'))
 
117
        self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
122
118
 
123
119
 
124
120
class TestRename(tests.TestCaseInTempDir):
138
134
        # This should work everywhere
139
135
        self.create_file('a', 'something in a\n')
140
136
        self._fancy_rename('a', 'b')
141
 
        self.failIfExists('a')
142
 
        self.failUnlessExists('b')
 
137
        self.assertPathDoesNotExist('a')
 
138
        self.assertPathExists('b')
143
139
        self.check_file_contents('b', 'something in a\n')
144
140
 
145
141
        self.create_file('a', 'new something in a\n')
152
148
        self.create_file('target', 'data in target\n')
153
149
        self.assertRaises((IOError, OSError), self._fancy_rename,
154
150
                          'missingsource', 'target')
155
 
        self.failUnlessExists('target')
 
151
        self.assertPathExists('target')
156
152
        self.check_file_contents('target', 'data in target\n')
157
153
 
158
154
    def test_fancy_rename_fails_if_source_and_target_missing(self):
163
159
        # Rename should be semi-atomic on all platforms
164
160
        self.create_file('a', 'something in a\n')
165
161
        osutils.rename('a', 'b')
166
 
        self.failIfExists('a')
167
 
        self.failUnlessExists('b')
 
162
        self.assertPathDoesNotExist('a')
 
163
        self.assertPathExists('b')
168
164
        self.check_file_contents('b', 'something in a\n')
169
165
 
170
166
        self.create_file('a', 'new something in a\n')
184
180
        shape = sorted(os.listdir('.'))
185
181
        self.assertEquals(['A', 'B'], shape)
186
182
 
187
 
    def test_rename_error(self):
188
 
        # We wrap os.rename to make it give an error including the filenames
189
 
        # https://bugs.launchpad.net/bzr/+bug/491763
190
 
        err = self.assertRaises(OSError, osutils.rename,
191
 
            'nonexistent', 'target')
192
 
        self.assertContainsString(str(err), 'nonexistent')
193
 
 
194
183
 
195
184
class TestRandChars(tests.TestCase):
196
185
 
242
231
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
243
232
 
244
233
 
 
234
class TestLstat(tests.TestCaseInTempDir):
 
235
 
 
236
    def test_lstat_matches_fstat(self):
 
237
        # On Windows, lstat and fstat don't always agree, primarily in the
 
238
        # 'st_ino' and 'st_dev' fields. So we force them to be '0' in our
 
239
        # custom implementation.
 
240
        if sys.platform == 'win32':
 
241
            # We only have special lstat/fstat if we have the extension.
 
242
            # Without it, we may end up re-reading content when we don't have
 
243
            # to, but otherwise it doesn't effect correctness.
 
244
            self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
245
        f = open('test-file.txt', 'wb')
 
246
        self.addCleanup(f.close)
 
247
        f.write('some content\n')
 
248
        f.flush()
 
249
        self.assertEqualStat(osutils.fstat(f.fileno()),
 
250
                             osutils.lstat('test-file.txt'))
 
251
 
 
252
 
245
253
class TestRmTree(tests.TestCaseInTempDir):
246
254
 
247
255
    def test_rmtree(self):
259
267
 
260
268
        osutils.rmtree('dir')
261
269
 
262
 
        self.failIfExists('dir/file')
263
 
        self.failIfExists('dir')
 
270
        self.assertPathDoesNotExist('dir/file')
 
271
        self.assertPathDoesNotExist('dir')
264
272
 
265
273
 
266
274
class TestDeleteAny(tests.TestCaseInTempDir):
480
488
        f = file('MixedCaseName', 'w')
481
489
        f.close()
482
490
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
483
 
        self.failUnlessEqual('work/MixedCaseName', actual)
 
491
        self.assertEqual('work/MixedCaseName', actual)
484
492
 
485
493
    def test_canonical_relpath_missing_tail(self):
486
494
        os.mkdir('MixedCaseParent')
487
495
        actual = osutils.canonical_relpath(self.test_base_dir,
488
496
                                           'mixedcaseparent/nochild')
489
 
        self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
 
497
        self.assertEqual('work/MixedCaseParent/nochild', actual)
490
498
 
491
499
 
492
500
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
868
876
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
869
877
        # relative path
870
878
        cwd = osutils.getcwd().rstrip('/')
871
 
        drive = osutils._nt_splitdrive(cwd)[0]
 
879
        drive = osutils.ntpath.splitdrive(cwd)[0]
872
880
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
873
881
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
874
882
        # unicode path
916
924
        b.close()
917
925
 
918
926
        osutils._win32_rename('b', 'a')
919
 
        self.failUnlessExists('a')
920
 
        self.failIfExists('b')
 
927
        self.assertPathExists('a')
 
928
        self.assertPathDoesNotExist('b')
921
929
        self.assertFileEqual('baz\n', 'a')
922
930
 
923
931
    def test_rename_missing_file(self):
1071
1079
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
1072
1080
 
1073
1081
    def test_walkdirs_os_error(self):
1074
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/338653>
 
1082
        # <https://bugs.launchpad.net/bzr/+bug/338653>
1075
1083
        # Pyrex readdir didn't raise useful messages if it had an error
1076
1084
        # reading the directory
1077
1085
        if sys.platform == 'win32':
1078
1086
            raise tests.TestNotApplicable(
1079
1087
                "readdir IOError not tested on win32")
 
1088
        self.requireFeature(features.not_running_as_root)
1080
1089
        os.mkdir("test-unreadable")
1081
1090
        os.chmod("test-unreadable", 0000)
1082
1091
        # must chmod it back so that it can be removed
1090
1099
        # Ensure the message contains the file name
1091
1100
        self.assertContainsRe(str(e), "\./test-unreadable")
1092
1101
 
 
1102
 
 
1103
    def test_walkdirs_encoding_error(self):
 
1104
        # <https://bugs.launchpad.net/bzr/+bug/488519>
 
1105
        # walkdirs didn't raise a useful message when the filenames
 
1106
        # are not using the filesystem's encoding
 
1107
 
 
1108
        # require a bytestring based filesystem
 
1109
        self.requireFeature(tests.ByteStringNamedFilesystem)
 
1110
 
 
1111
        tree = [
 
1112
            '.bzr',
 
1113
            '0file',
 
1114
            '1dir/',
 
1115
            '1dir/0file',
 
1116
            '1dir/1dir/',
 
1117
            '1file'
 
1118
            ]
 
1119
 
 
1120
        self.build_tree(tree)
 
1121
 
 
1122
        # rename the 1file to a latin-1 filename
 
1123
        os.rename("./1file", "\xe8file")
 
1124
        if "\xe8file" not in os.listdir("."):
 
1125
            self.skip("Lack filesystem that preserves arbitrary bytes")
 
1126
 
 
1127
        self._save_platform_info()
 
1128
        win32utils.winver = None # Avoid the win32 detection code
 
1129
        osutils._fs_enc = 'UTF-8'
 
1130
 
 
1131
        # this should raise on error
 
1132
        def attempt():
 
1133
            for dirdetail, dirblock in osutils.walkdirs('.'):
 
1134
                pass
 
1135
 
 
1136
        self.assertRaises(errors.BadFilenameEncoding, attempt)
 
1137
 
1093
1138
    def test__walkdirs_utf8(self):
1094
1139
        tree = [
1095
1140
            '.bzr',
1569
1614
                          ('d', 'source/b', 'target/b'),
1570
1615
                          ('f', 'source/b/c', 'target/b/c'),
1571
1616
                         ], processed_files)
1572
 
        self.failIfExists('target')
 
1617
        self.assertPathDoesNotExist('target')
1573
1618
        if osutils.has_symlinks():
1574
1619
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1575
1620
 
1621
1666
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1622
1667
        self.assertEqual('foo', old)
1623
1668
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1624
 
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
 
1669
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
1625
1670
 
1626
1671
 
1627
1672
class TestSizeShaFile(tests.TestCaseInTempDir):
1678
1723
 
1679
1724
class TestReCompile(tests.TestCase):
1680
1725
 
 
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)
 
1729
 
1681
1730
    def test_re_compile_checked(self):
1682
 
        r = osutils.re_compile_checked(r'A*', re.IGNORECASE)
 
1731
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1683
1732
        self.assertTrue(r.match('aaaa'))
1684
1733
        self.assertTrue(r.match('aAaA'))
1685
1734
 
1686
1735
    def test_re_compile_checked_error(self):
1687
1736
        # like https://bugs.launchpad.net/bzr/+bug/251352
 
1737
 
 
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()
1688
1741
        err = self.assertRaises(
1689
1742
            errors.BzrCommandError,
1690
 
            osutils.re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1743
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1691
1744
        self.assertEqual(
1692
 
            "Invalid regular expression in test case: '*': "
1693
 
            "nothing to repeat",
 
1745
            'Invalid regular expression in test case: '
 
1746
            '"*" nothing to repeat',
1694
1747
            str(err))
1695
1748
 
1696
1749
 
1697
1750
class TestDirReader(tests.TestCaseInTempDir):
1698
1751
 
 
1752
    scenarios = dir_reader_scenarios()
 
1753
 
1699
1754
    # Set by load_tests
1700
1755
    _dir_reader_class = None
1701
1756
    _native_to_unicode = None
1842
1897
        os.symlink(self.target, self.link)
1843
1898
 
1844
1899
    def test_os_readlink_link_encoding(self):
1845
 
        if sys.version_info < (2, 6):
1846
 
            self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
1847
 
        else:
1848
 
            self.assertEquals(self.target,  os.readlink(self.link))
 
1900
        self.assertEquals(self.target,  os.readlink(self.link))
1849
1901
 
1850
1902
    def test_os_readlink_link_decoding(self):
1851
1903
        self.assertEquals(self.target.encode(osutils._fs_enc),
1863
1915
        self.assertIsInstance(concurrency, int)
1864
1916
 
1865
1917
    def test_local_concurrency_environment_variable(self):
1866
 
        os.environ['BZR_CONCURRENCY'] = '2'
 
1918
        self.overrideEnv('BZR_CONCURRENCY', '2')
1867
1919
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1868
 
        os.environ['BZR_CONCURRENCY'] = '3'
 
1920
        self.overrideEnv('BZR_CONCURRENCY', '3')
1869
1921
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1870
 
        os.environ['BZR_CONCURRENCY'] = 'foo'
 
1922
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
1871
1923
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1872
1924
 
1873
1925
    def test_option_concurrency(self):
1874
 
        os.environ['BZR_CONCURRENCY'] = '1'
 
1926
        self.overrideEnv('BZR_CONCURRENCY', '1')
1875
1927
        self.run_bzr('rocks --concurrency 42')
1876
 
        # Command line overrides envrionment variable
 
1928
        # Command line overrides environment variable
1877
1929
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1878
1930
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
1879
1931
 
1917
1969
 
1918
1970
class TestTerminalWidth(tests.TestCase):
1919
1971
 
 
1972
    def setUp(self):
 
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
 
1979
 
 
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
 
1983
 
1920
1984
    def replace_stdout(self, new):
1921
1985
        self.overrideAttr(sys, 'stdout', new)
1922
1986
 
1937
2001
    def test_defaults_to_BZR_COLUMNS(self):
1938
2002
        # BZR_COLUMNS is set by the test framework
1939
2003
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
1940
 
        os.environ['BZR_COLUMNS'] = '12'
 
2004
        self.overrideEnv('BZR_COLUMNS', '12')
1941
2005
        self.assertEqual(12, osutils.terminal_width())
1942
2006
 
 
2007
    def test_BZR_COLUMNS_0_no_limit(self):
 
2008
        self.overrideEnv('BZR_COLUMNS', '0')
 
2009
        self.assertEqual(None, osutils.terminal_width())
 
2010
 
1943
2011
    def test_falls_back_to_COLUMNS(self):
1944
 
        del os.environ['BZR_COLUMNS']
 
2012
        self.overrideEnv('BZR_COLUMNS', None)
1945
2013
        self.assertNotEqual('42', os.environ['COLUMNS'])
1946
2014
        self.set_fake_tty()
1947
 
        os.environ['COLUMNS'] = '42'
 
2015
        self.overrideEnv('COLUMNS', '42')
1948
2016
        self.assertEqual(42, osutils.terminal_width())
1949
2017
 
1950
2018
    def test_tty_default_without_columns(self):
1951
 
        del os.environ['BZR_COLUMNS']
1952
 
        del os.environ['COLUMNS']
 
2019
        self.overrideEnv('BZR_COLUMNS', None)
 
2020
        self.overrideEnv('COLUMNS', None)
1953
2021
 
1954
2022
        def terminal_size(w, h):
1955
2023
            return 42, 42
1962
2030
        self.assertEqual(42, osutils.terminal_width())
1963
2031
 
1964
2032
    def test_non_tty_default_without_columns(self):
1965
 
        del os.environ['BZR_COLUMNS']
1966
 
        del os.environ['COLUMNS']
 
2033
        self.overrideEnv('BZR_COLUMNS', None)
 
2034
        self.overrideEnv('COLUMNS', None)
1967
2035
        self.replace_stdout(None)
1968
2036
        self.assertEqual(None, osutils.terminal_width())
1969
2037
 
1979
2047
        else:
1980
2048
            self.overrideAttr(termios, 'TIOCGWINSZ')
1981
2049
            del termios.TIOCGWINSZ
1982
 
        del os.environ['BZR_COLUMNS']
1983
 
        del os.environ['COLUMNS']
 
2050
        self.overrideEnv('BZR_COLUMNS', None)
 
2051
        self.overrideEnv('COLUMNS', None)
1984
2052
        # Whatever the result is, if we don't raise an exception, it's ok.
1985
2053
        osutils.terminal_width()
1986
2054
 
2018
2086
        self.assertEquals(self.path, 'test_file')
2019
2087
        self.assertEquals(self.uid, s.st_uid)
2020
2088
        self.assertEquals(self.gid, s.st_gid)
 
2089
 
 
2090
class TestGetuserUnicode(tests.TestCase):
 
2091
 
 
2092
    def test_ascii_user(self):
 
2093
        self.overrideEnv('LOGNAME', 'jrandom')
 
2094
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
 
2095
 
 
2096
    def test_unicode_user(self):
 
2097
        ue = osutils.get_user_encoding()
 
2098
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
2099
        if uni_val is None:
 
2100
            raise tests.TestSkipped(
 
2101
                'Cannot find a unicode character that works in encoding %s'
 
2102
                % (osutils.get_user_encoding(),))
 
2103
        uni_username = u'jrandom' + uni_val
 
2104
        encoded_username = uni_username.encode(ue)
 
2105
        self.overrideEnv('LOGNAME', encoded_username)
 
2106
        self.assertEqual(uni_username, osutils.getuser_unicode())
 
2107
        self.overrideEnv('LOGNAME', u'jrandom\xb6'.encode(ue))
 
2108
        self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
 
2109
 
 
2110
class TestBackupNames(tests.TestCase):
 
2111
 
 
2112
    def setUp(self):
 
2113
        super(TestBackupNames, self).setUp()
 
2114
        self.backups = []
 
2115
 
 
2116
    def backup_exists(self, name):
 
2117
        return name in self.backups
 
2118
 
 
2119
    def available_backup_name(self, name):
 
2120
        backup_name = osutils.available_backup_name(name, self.backup_exists)
 
2121
        self.backups.append(backup_name)
 
2122
        return backup_name
 
2123
 
 
2124
    def assertBackupName(self, expected, name):
 
2125
        self.assertEqual(expected, self.available_backup_name(name))
 
2126
 
 
2127
    def test_empty(self):
 
2128
        self.assertBackupName('file.~1~', 'file')
 
2129
 
 
2130
    def test_existing(self):
 
2131
        self.available_backup_name('file')
 
2132
        self.available_backup_name('file')
 
2133
        self.assertBackupName('file.~3~', 'file')
 
2134
        # Empty slots are found, this is not a strict requirement and may be
 
2135
        # revisited if we test against all implementations.
 
2136
        self.backups.remove('file.~2~')
 
2137
        self.assertBackupName('file.~2~', 'file')
 
2138
 
 
2139
 
 
2140
class TestFindExecutableInPath(tests.TestCase):
 
2141
 
 
2142
    def test_windows(self):
 
2143
        if sys.platform != 'win32':
 
2144
            raise tests.TestSkipped('test requires win32')
 
2145
        self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
 
2146
        self.assertTrue(
 
2147
            osutils.find_executable_on_path('explorer.exe') is not None)
 
2148
        self.assertTrue(
 
2149
            osutils.find_executable_on_path('EXPLORER.EXE') is not None)
 
2150
        self.assertTrue(
 
2151
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2152
        self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
 
2153
 
 
2154
    def test_other(self):
 
2155
        if sys.platform == 'win32':
 
2156
            raise tests.TestSkipped('test requires non-win32')
 
2157
        self.assertTrue(osutils.find_executable_on_path('sh') is not None)
 
2158
        self.assertTrue(
 
2159
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)