← 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: Martin Pool
  • Date: 2011-02-07 01:39:42 UTC
  • mto: This revision was merged to the branch mainline in revision 5650.
  • Revision ID: mbp@canonical.com-20110207013942-roj88kez6jir13tr
Add brief user documentation of command line splitting

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):
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
 
868
857
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
869
858
        # relative path
870
859
        cwd = osutils.getcwd().rstrip('/')
871
 
        drive = osutils._nt_splitdrive(cwd)[0]
 
860
        drive = osutils.ntpath.splitdrive(cwd)[0]
872
861
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
873
862
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
874
863
        # unicode path
1071
1060
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
1072
1061
 
1073
1062
    def test_walkdirs_os_error(self):
1074
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/338653>
 
1063
        # <https://bugs.launchpad.net/bzr/+bug/338653>
1075
1064
        # Pyrex readdir didn't raise useful messages if it had an error
1076
1065
        # reading the directory
1077
1066
        if sys.platform == 'win32':
1078
1067
            raise tests.TestNotApplicable(
1079
1068
                "readdir IOError not tested on win32")
 
1069
        self.requireFeature(features.not_running_as_root)
1080
1070
        os.mkdir("test-unreadable")
1081
1071
        os.chmod("test-unreadable", 0000)
1082
1072
        # must chmod it back so that it can be removed
1090
1080
        # Ensure the message contains the file name
1091
1081
        self.assertContainsRe(str(e), "\./test-unreadable")
1092
1082
 
 
1083
 
 
1084
    def test_walkdirs_encoding_error(self):
 
1085
        # <https://bugs.launchpad.net/bzr/+bug/488519>
 
1086
        # walkdirs didn't raise a useful message when the filenames
 
1087
        # are not using the filesystem's encoding
 
1088
 
 
1089
        # require a bytestring based filesystem
 
1090
        self.requireFeature(tests.ByteStringNamedFilesystem)
 
1091
 
 
1092
        tree = [
 
1093
            '.bzr',
 
1094
            '0file',
 
1095
            '1dir/',
 
1096
            '1dir/0file',
 
1097
            '1dir/1dir/',
 
1098
            '1file'
 
1099
            ]
 
1100
 
 
1101
        self.build_tree(tree)
 
1102
 
 
1103
        # rename the 1file to a latin-1 filename
 
1104
        os.rename("./1file", "\xe8file")
 
1105
        if "\xe8file" not in os.listdir("."):
 
1106
            self.skip("Lack filesystem that preserves arbitrary bytes")
 
1107
 
 
1108
        self._save_platform_info()
 
1109
        win32utils.winver = None # Avoid the win32 detection code
 
1110
        osutils._fs_enc = 'UTF-8'
 
1111
 
 
1112
        # this should raise on error
 
1113
        def attempt():
 
1114
            for dirdetail, dirblock in osutils.walkdirs('.'):
 
1115
                pass
 
1116
 
 
1117
        self.assertRaises(errors.BadFilenameEncoding, attempt)
 
1118
 
1093
1119
    def test__walkdirs_utf8(self):
1094
1120
        tree = [
1095
1121
            '.bzr',
1678
1704
 
1679
1705
class TestReCompile(tests.TestCase):
1680
1706
 
 
1707
    def _deprecated_re_compile_checked(self, *args, **kwargs):
 
1708
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
 
1709
            osutils.re_compile_checked, *args, **kwargs)
 
1710
 
1681
1711
    def test_re_compile_checked(self):
1682
 
        r = osutils.re_compile_checked(r'A*', re.IGNORECASE)
 
1712
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
1683
1713
        self.assertTrue(r.match('aaaa'))
1684
1714
        self.assertTrue(r.match('aAaA'))
1685
1715
 
1686
1716
    def test_re_compile_checked_error(self):
1687
1717
        # like https://bugs.launchpad.net/bzr/+bug/251352
 
1718
 
 
1719
        # Due to possible test isolation error, re.compile is not lazy at
 
1720
        # this point. We re-install lazy compile.
 
1721
        lazy_regex.install_lazy_compile()
1688
1722
        err = self.assertRaises(
1689
1723
            errors.BzrCommandError,
1690
 
            osutils.re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1724
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
1691
1725
        self.assertEqual(
1692
 
            "Invalid regular expression in test case: '*': "
1693
 
            "nothing to repeat",
 
1726
            'Invalid regular expression in test case: '
 
1727
            '"*" nothing to repeat',
1694
1728
            str(err))
1695
1729
 
1696
1730
 
1697
1731
class TestDirReader(tests.TestCaseInTempDir):
1698
1732
 
 
1733
    scenarios = dir_reader_scenarios()
 
1734
 
1699
1735
    # Set by load_tests
1700
1736
    _dir_reader_class = None
1701
1737
    _native_to_unicode = None
1863
1899
        self.assertIsInstance(concurrency, int)
1864
1900
 
1865
1901
    def test_local_concurrency_environment_variable(self):
1866
 
        os.environ['BZR_CONCURRENCY'] = '2'
 
1902
        self.overrideEnv('BZR_CONCURRENCY', '2')
1867
1903
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1868
 
        os.environ['BZR_CONCURRENCY'] = '3'
 
1904
        self.overrideEnv('BZR_CONCURRENCY', '3')
1869
1905
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1870
 
        os.environ['BZR_CONCURRENCY'] = 'foo'
 
1906
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
1871
1907
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1872
1908
 
1873
1909
    def test_option_concurrency(self):
1874
 
        os.environ['BZR_CONCURRENCY'] = '1'
 
1910
        self.overrideEnv('BZR_CONCURRENCY', '1')
1875
1911
        self.run_bzr('rocks --concurrency 42')
1876
 
        # Command line overrides envrionment variable
 
1912
        # Command line overrides environment variable
1877
1913
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1878
1914
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
1879
1915
 
1917
1953
 
1918
1954
class TestTerminalWidth(tests.TestCase):
1919
1955
 
 
1956
    def setUp(self):
 
1957
        tests.TestCase.setUp(self)
 
1958
        self._orig_terminal_size_state = osutils._terminal_size_state
 
1959
        self._orig_first_terminal_size = osutils._first_terminal_size
 
1960
        self.addCleanup(self.restore_osutils_globals)
 
1961
        osutils._terminal_size_state = 'no_data'
 
1962
        osutils._first_terminal_size = None
 
1963
 
 
1964
    def restore_osutils_globals(self):
 
1965
        osutils._terminal_size_state = self._orig_terminal_size_state
 
1966
        osutils._first_terminal_size = self._orig_first_terminal_size
 
1967
 
1920
1968
    def replace_stdout(self, new):
1921
1969
        self.overrideAttr(sys, 'stdout', new)
1922
1970
 
1937
1985
    def test_defaults_to_BZR_COLUMNS(self):
1938
1986
        # BZR_COLUMNS is set by the test framework
1939
1987
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
1940
 
        os.environ['BZR_COLUMNS'] = '12'
 
1988
        self.overrideEnv('BZR_COLUMNS', '12')
1941
1989
        self.assertEqual(12, osutils.terminal_width())
1942
1990
 
 
1991
    def test_BZR_COLUMNS_0_no_limit(self):
 
1992
        self.overrideEnv('BZR_COLUMNS', '0')
 
1993
        self.assertEqual(None, osutils.terminal_width())
 
1994
 
1943
1995
    def test_falls_back_to_COLUMNS(self):
1944
 
        del os.environ['BZR_COLUMNS']
 
1996
        self.overrideEnv('BZR_COLUMNS', None)
1945
1997
        self.assertNotEqual('42', os.environ['COLUMNS'])
1946
1998
        self.set_fake_tty()
1947
 
        os.environ['COLUMNS'] = '42'
 
1999
        self.overrideEnv('COLUMNS', '42')
1948
2000
        self.assertEqual(42, osutils.terminal_width())
1949
2001
 
1950
2002
    def test_tty_default_without_columns(self):
1951
 
        del os.environ['BZR_COLUMNS']
1952
 
        del os.environ['COLUMNS']
 
2003
        self.overrideEnv('BZR_COLUMNS', None)
 
2004
        self.overrideEnv('COLUMNS', None)
1953
2005
 
1954
2006
        def terminal_size(w, h):
1955
2007
            return 42, 42
1962
2014
        self.assertEqual(42, osutils.terminal_width())
1963
2015
 
1964
2016
    def test_non_tty_default_without_columns(self):
1965
 
        del os.environ['BZR_COLUMNS']
1966
 
        del os.environ['COLUMNS']
 
2017
        self.overrideEnv('BZR_COLUMNS', None)
 
2018
        self.overrideEnv('COLUMNS', None)
1967
2019
        self.replace_stdout(None)
1968
2020
        self.assertEqual(None, osutils.terminal_width())
1969
2021
 
1979
2031
        else:
1980
2032
            self.overrideAttr(termios, 'TIOCGWINSZ')
1981
2033
            del termios.TIOCGWINSZ
1982
 
        del os.environ['BZR_COLUMNS']
1983
 
        del os.environ['COLUMNS']
 
2034
        self.overrideEnv('BZR_COLUMNS', None)
 
2035
        self.overrideEnv('COLUMNS', None)
1984
2036
        # Whatever the result is, if we don't raise an exception, it's ok.
1985
2037
        osutils.terminal_width()
1986
2038
 
2018
2070
        self.assertEquals(self.path, 'test_file')
2019
2071
        self.assertEquals(self.uid, s.st_uid)
2020
2072
        self.assertEquals(self.gid, s.st_gid)
 
2073
 
 
2074
class TestGetuserUnicode(tests.TestCase):
 
2075
 
 
2076
    def test_ascii_user(self):
 
2077
        self.overrideEnv('LOGNAME', 'jrandom')
 
2078
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
 
2079
 
 
2080
    def test_unicode_user(self):
 
2081
        ue = osutils.get_user_encoding()
 
2082
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
 
2083
        if uni_val is None:
 
2084
            raise tests.TestSkipped(
 
2085
                'Cannot find a unicode character that works in encoding %s'
 
2086
                % (osutils.get_user_encoding(),))
 
2087
        uni_username = u'jrandom' + uni_val
 
2088
        encoded_username = uni_username.encode(ue)
 
2089
        self.overrideEnv('LOGNAME', encoded_username)
 
2090
        self.assertEqual(uni_username, osutils.getuser_unicode())
 
2091
        self.overrideEnv('LOGNAME', u'jrandom\xb6'.encode(ue))
 
2092
        self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
 
2093
 
 
2094
class TestBackupNames(tests.TestCase):
 
2095
 
 
2096
    def setUp(self):
 
2097
        super(TestBackupNames, self).setUp()
 
2098
        self.backups = []
 
2099
 
 
2100
    def backup_exists(self, name):
 
2101
        return name in self.backups
 
2102
 
 
2103
    def available_backup_name(self, name):
 
2104
        backup_name = osutils.available_backup_name(name, self.backup_exists)
 
2105
        self.backups.append(backup_name)
 
2106
        return backup_name
 
2107
 
 
2108
    def assertBackupName(self, expected, name):
 
2109
        self.assertEqual(expected, self.available_backup_name(name))
 
2110
 
 
2111
    def test_empty(self):
 
2112
        self.assertBackupName('file.~1~', 'file')
 
2113
 
 
2114
    def test_existing(self):
 
2115
        self.available_backup_name('file')
 
2116
        self.available_backup_name('file')
 
2117
        self.assertBackupName('file.~3~', 'file')
 
2118
        # Empty slots are found, this is not a strict requirement and may be
 
2119
        # revisited if we test against all implementations.
 
2120
        self.backups.remove('file.~2~')
 
2121
        self.assertBackupName('file.~2~', 'file')
 
2122
 
 
2123
 
 
2124
class TestFindExecutableInPath(tests.TestCase):
 
2125
 
 
2126
    def test_windows(self):
 
2127
        if sys.platform != 'win32':
 
2128
            raise tests.TestSkipped('test requires win32')
 
2129
        self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
 
2130
        self.assertTrue(
 
2131
            osutils.find_executable_on_path('explorer.exe') is not None)
 
2132
        self.assertTrue(
 
2133
            osutils.find_executable_on_path('EXPLORER.EXE') is not None)
 
2134
        self.assertTrue(
 
2135
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
 
2136
        self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
 
2137
 
 
2138
    def test_other(self):
 
2139
        if sys.platform == 'win32':
 
2140
            raise tests.TestSkipped('test requires non-win32')
 
2141
        self.assertTrue(osutils.find_executable_on_path('sh') is not None)
 
2142
        self.assertTrue(
 
2143
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)