1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for the osutils wrapper."""
28
from bzrlib.tests import (
34
class FakeCodec(object):
35
"""Special class that helps testing over several non-existed encodings.
37
Clients can add new encoding names, but because of how codecs is
38
implemented they cannot be removed. Be careful with naming to avoid
39
collisions between tests.
42
_enabled_encodings = set()
44
def add(self, encoding_name):
45
"""Adding encoding name to fake.
47
:type encoding_name: lowercase plain string
49
if not self._registered:
51
self._registered = True
52
if encoding_name is not None:
53
self._enabled_encodings.add(encoding_name)
55
def __call__(self, encoding_name):
56
"""Called indirectly by codecs module during lookup"""
57
if encoding_name in self._enabled_encodings:
58
return codecs.lookup('latin-1')
61
fake_codec = FakeCodec()
64
class TestFakeCodec(TestCase):
66
def test_fake_codec(self):
67
self.assertRaises(LookupError, codecs.lookup, 'fake')
69
fake_codec.add('fake')
73
class TestTerminalEncoding(TestCase):
74
"""Test the auto-detection of proper terminal encoding."""
78
self._stdout = sys.stdout
79
self._stderr = sys.stderr
80
self._stdin = sys.stdin
81
self._user_encoding = osutils._cached_user_encoding
83
self.addCleanup(self._reset)
85
def make_wrapped_streams(self,
89
user_encoding='user_encoding',
90
enable_fake_encodings=True):
91
sys.stdout = StringIOWrapper()
92
sys.stdout.encoding = stdout_encoding
93
sys.stderr = StringIOWrapper()
94
sys.stderr.encoding = stderr_encoding
95
sys.stdin = StringIOWrapper()
96
sys.stdin.encoding = stdin_encoding
97
osutils._cached_user_encoding = user_encoding
98
if enable_fake_encodings:
99
fake_codec.add(stdout_encoding)
100
fake_codec.add(stderr_encoding)
101
fake_codec.add(stdin_encoding)
104
sys.stdout = self._stdout
105
sys.stderr = self._stderr
106
sys.stdin = self._stdin
107
osutils._cached_user_encoding = self._user_encoding
109
def test_get_terminal_encoding(self):
110
self.make_wrapped_streams('stdout_encoding',
114
# first preference is stdout encoding
115
self.assertEqual('stdout_encoding', osutils.get_terminal_encoding())
117
sys.stdout.encoding = None
118
# if sys.stdout is None, fall back to sys.stdin
119
self.assertEqual('stdin_encoding', osutils.get_terminal_encoding())
121
sys.stdin.encoding = None
122
# and in the worst case, use osutils.get_user_encoding()
123
self.assertEqual('user_encoding', osutils.get_terminal_encoding())
125
def test_terminal_cp0(self):
126
# test cp0 encoding (Windows returns cp0 when there is no encoding)
127
self.make_wrapped_streams('cp0',
130
user_encoding='latin-1',
131
enable_fake_encodings=False)
133
# cp0 is invalid encoding. We should fall back to user_encoding
134
self.assertEqual('latin-1', osutils.get_terminal_encoding())
137
self.assertEquals('', sys.stderr.getvalue())
139
def test_terminal_cp_unknown(self):
140
# test against really unknown encoding
141
# catch warning at stderr
142
self.make_wrapped_streams('cp-unknown',
145
user_encoding='latin-1',
146
enable_fake_encodings=False)
148
self.assertEqual('latin-1', osutils.get_terminal_encoding())
151
self.assertEquals('bzr: warning: unknown terminal encoding cp-unknown.\n'
152
' Using encoding latin-1 instead.\n',
153
sys.stderr.getvalue())
156
class TestUserEncoding(TestCase):
157
"""Test detection of default user encoding."""
161
self._stderr = sys.stderr
162
self._getpreferredencoding = locale.getpreferredencoding
163
self.addCleanup(self._reset)
164
sys.stderr = StringIOWrapper()
166
self._LANG = os.environ.get('LANG')
169
locale.getpreferredencoding = self._getpreferredencoding
170
sys.stderr = self._stderr
172
osutils.set_or_unset_env('LANG', self._LANG)
174
def test_get_user_encoding(self):
176
return 'user_encoding'
178
locale.getpreferredencoding = f
179
fake_codec.add('user_encoding')
180
self.assertEquals('user_encoding', osutils.get_user_encoding(use_cache=False))
181
self.assertEquals('', sys.stderr.getvalue())
183
def test_user_cp0(self):
187
locale.getpreferredencoding = f
188
self.assertEquals('ascii', osutils.get_user_encoding(use_cache=False))
189
self.assertEquals('', sys.stderr.getvalue())
191
def test_user_cp_unknown(self):
195
locale.getpreferredencoding = f
196
self.assertEquals('ascii', osutils.get_user_encoding(use_cache=False))
197
self.assertEquals('bzr: warning: unknown encoding cp-unknown.'
198
' Continuing with ascii encoding.\n',
199
sys.stderr.getvalue())
201
def test_user_empty(self):
202
"""Running bzr from a vim script gives '' for a preferred locale"""
206
locale.getpreferredencoding = f
207
self.assertEquals('ascii', osutils.get_user_encoding(use_cache=False))
208
self.assertEquals('', sys.stderr.getvalue())
210
def test_user_locale_error(self):
212
raise locale.Error, 'unsupported locale'
214
locale.getpreferredencoding = f
215
os.environ['LANG'] = 'BOGUS'
216
self.assertEquals('ascii', osutils.get_user_encoding(use_cache=False))
217
self.assertEquals('bzr: warning: unsupported locale\n'
218
' Could not determine what text encoding to use.\n'
219
' This error usually means your Python interpreter\n'
220
' doesn\'t support the locale set by $LANG (BOGUS)\n'
221
' Continuing with ascii encoding.\n',
222
sys.stderr.getvalue())