31
from bzrlib.branch import Branch
32
from bzrlib.config import ensure_config_dir_exists, config_filename
33
from bzrlib.msgeditor import (
31
from ..msgeditor import (
34
32
make_commit_message_template_encoded,
35
33
edit_commit_message_encoded
37
from bzrlib.tests import (
39
38
TestCaseWithTransport,
43
41
probe_bad_non_ascii,
42
probe_unicode_in_user_encoding,
46
from bzrlib.tests.EncodingAdapter import encoding_scenarios
47
from bzrlib.trace import mutter
50
def load_tests(standard_tests, module, loader):
45
from .EncodingAdapter import encoding_scenarios
46
from ..trace import mutter
49
def load_tests(loader, standard_tests, pattern):
51
50
"""Parameterize the test for tempfile creation with different encodings."""
52
51
to_adapt, result = split_suite_by_re(standard_tests,
53
52
"test__create_temp_file_with_commit_template_in_unicode_dir")
83
82
def make_multiple_pending_tree(self):
84
from bzrlib import config
85
config.GlobalConfig().set_user_option('email',
86
'Bilbo Baggins <bb@hobbit.net>')
83
config.GlobalStack().set('email', 'Bilbo Baggins <bb@hobbit.net>')
87
84
tree = self.make_branch_and_tree('a')
88
85
tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
89
tree2 = tree.bzrdir.clone('b').open_workingtree()
86
tree2 = tree.controldir.clone('b').open_workingtree()
90
87
tree.commit('Minor tweak.', timestamp=1231977840, timezone=0)
91
88
tree2.commit('Feature X work.', timestamp=1233186240, timezone=0)
92
tree3 = tree2.bzrdir.clone('c').open_workingtree()
89
tree3 = tree2.controldir.clone('c').open_workingtree()
93
90
tree2.commit('Feature X finished.', timestamp=1233187680, timezone=0)
94
91
tree3.commit('Feature Y, based on initial X work.',
95
92
timestamp=1233285960, timezone=0)
143
140
""".encode('utf8') in template)
145
def make_do_nothing_editor(self):
142
def make_do_nothing_editor(self, basename='fed'):
146
143
if sys.platform == "win32":
147
f = file('fed.bat', 'w')
148
f.write('@rem dummy fed')
144
name = basename + '.bat'
145
with open(name, 'w') as f:
146
f.write('@rem dummy fed')
152
f = file('fed.sh', 'wb')
153
f.write('#!/bin/sh\n')
155
os.chmod('fed.sh', 0755)
149
name = basename + '.sh'
150
with open(name, 'wb') as f:
151
f.write(b'#!/bin/sh\n')
152
os.chmod(name, 0o755)
158
155
def test_run_editor(self):
159
os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
156
self.overrideEnv('BRZ_EDITOR', self.make_do_nothing_editor())
160
157
self.assertEqual(True, msgeditor._run_editor(''),
161
158
'Unable to run dummy fake editor')
160
def test_parse_editor_name(self):
161
"""Correctly interpret names with spaces.
163
See <https://bugs.launchpad.net/bzr/+bug/220331>
165
self.overrideEnv('BRZ_EDITOR',
166
'"%s"' % self.make_do_nothing_editor('name with spaces'))
167
self.assertEqual(True, msgeditor._run_editor('a_filename'))
163
169
def make_fake_editor(self, message='test message from fed\\n'):
164
170
"""Set up environment so that an editor will be a known script.
166
Sets up BZR_EDITOR so that if an editor is spawned it will run a
172
Sets up BRZ_EDITOR so that if an editor is spawned it will run a
167
173
script that just adds a known message to the start of the file.
169
f = file('fed.py', 'wb')
170
f.write('#!%s\n' % sys.executable)
175
with open('fed.py', 'wb') as f:
176
f.write(b'#!%s\n' % sys.executable)
174
180
if len(sys.argv) == 2:
183
189
""" % (message, ))
185
190
if sys.platform == "win32":
186
# [win32] make batch file and set BZR_EDITOR
187
f = file('fed.bat', 'w')
191
# [win32] make batch file and set BRZ_EDITOR
192
with open('fed.bat', 'w') as f:
191
196
""" % sys.executable)
193
os.environ['BZR_EDITOR'] = 'fed.bat'
197
self.overrideEnv('BRZ_EDITOR', 'fed.bat')
195
# [non-win32] make python script executable and set BZR_EDITOR
196
os.chmod('fed.py', 0755)
197
os.environ['BZR_EDITOR'] = './fed.py'
199
# [non-win32] make python script executable and set BRZ_EDITOR
200
os.chmod('fed.py', 0o755)
201
self.overrideEnv('BRZ_EDITOR', './fed.py')
199
def test_edit_commit_message(self):
203
def test_edit_commit_message_without_infotext(self):
200
204
working_tree = self.make_uncommitted_tree()
201
205
self.make_fake_editor()
204
208
self.assertEqual('test message from fed\n',
205
209
msgeditor.edit_commit_message(''))
211
def test_edit_commit_message_with_ascii_infotext(self):
212
working_tree = self.make_uncommitted_tree()
213
self.make_fake_editor()
207
215
mutter('edit_commit_message with ascii string infotext')
208
216
self.assertEqual('test message from fed\n',
209
217
msgeditor.edit_commit_message('spam'))
219
def test_edit_commit_message_with_unicode_infotext(self):
220
working_tree = self.make_uncommitted_tree()
221
self.make_fake_editor()
211
223
mutter('edit_commit_message with unicode infotext')
224
uni_val, ue_val = probe_unicode_in_user_encoding()
227
'Cannot find a unicode character that works in encoding %s'
228
% (osutils.get_user_encoding(),))
212
230
self.assertEqual('test message from fed\n',
213
msgeditor.edit_commit_message(u'\u1234'))
231
msgeditor.edit_commit_message(uni_val))
215
233
tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
216
234
self.assertEqual('test message from fed\n', tmpl)
229
247
working_tree = self.make_uncommitted_tree()
231
249
if sys.platform == 'win32':
232
os.environ['BZR_EDITOR'] = 'cmd.exe /c del'
250
editor = 'cmd.exe /c del'
234
os.environ['BZR_EDITOR'] = 'rm'
253
self.overrideEnv('BRZ_EDITOR', editor)
236
255
self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
238
257
def test__get_editor(self):
239
# Test that _get_editor can return a decent list of items
240
bzr_editor = os.environ.get('BZR_EDITOR')
241
visual = os.environ.get('VISUAL')
242
editor = os.environ.get('EDITOR')
244
os.environ['BZR_EDITOR'] = 'bzr_editor'
245
os.environ['VISUAL'] = 'visual'
246
os.environ['EDITOR'] = 'editor'
248
ensure_config_dir_exists()
249
f = open(config_filename(), 'wb')
250
f.write('editor = config_editor\n')
253
editors = list(msgeditor._get_editor())
254
editors = [editor for (editor, cfg_src) in editors]
256
self.assertEqual(['bzr_editor', 'config_editor', 'visual',
257
'editor'], editors[:4])
259
if sys.platform == 'win32':
260
self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
262
self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano',
266
# Restore the environment
267
if bzr_editor is None:
268
del os.environ['BZR_EDITOR']
270
os.environ['BZR_EDITOR'] = bzr_editor
272
del os.environ['VISUAL']
274
os.environ['VISUAL'] = visual
276
del os.environ['EDITOR']
278
os.environ['EDITOR'] = editor
258
self.overrideEnv('BRZ_EDITOR', 'bzr_editor')
259
self.overrideEnv('VISUAL', 'visual')
260
self.overrideEnv('EDITOR', 'editor')
262
conf = config.GlobalStack()
263
conf.store._load_from_string(b'[DEFAULT]\neditor = config_editor\n')
265
editors = list(msgeditor._get_editor())
266
editors = [editor for (editor, cfg_src) in editors]
268
self.assertEqual(['bzr_editor', 'config_editor', 'visual', 'editor'],
271
if sys.platform == 'win32':
272
self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
274
self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe'],
280
278
def test__run_editor_EACCES(self):
281
279
"""If running a configured editor raises EACESS, the user is warned."""
282
os.environ['BZR_EDITOR'] = 'eacces.py'
283
f = file('eacces.py', 'wb')
284
f.write('# Not a real editor')
280
self.overrideEnv('BRZ_EDITOR', 'eacces.py')
281
with open('eacces.py', 'wb') as f:
282
f.write(b'# Not a real editor')
286
283
# Make the fake editor unreadable (and unexecutable)
287
284
os.chmod('eacces.py', 0)
288
285
# Set $EDITOR so that _run_editor will terminate before trying real
290
os.environ['EDITOR'] = self.make_do_nothing_editor()
287
self.overrideEnv('EDITOR', self.make_do_nothing_editor())
291
288
# Call _run_editor, capturing mutter.warning calls.
293
290
def warning(*args):
307
304
# check that commit template written properly
308
305
# and has platform native line-endings (CRLF on win32)
309
306
create_file = msgeditor._create_temp_file_with_commit_template
310
msgfilename, hasinfo = create_file('infotext','----','start message')
307
msgfilename, hasinfo = create_file('infotext', '----', 'start message')
311
308
self.assertNotEqual(None, msgfilename)
312
309
self.assertTrue(hasinfo)
313
310
expected = os.linesep.join(['start message',
319
316
self.assertFileEqual(expected, msgfilename)
321
318
def test__create_temp_file_with_commit_template_in_unicode_dir(self):
322
self.requireFeature(tests.UnicodeFilenameFeature)
319
self.requireFeature(features.UnicodeFilenameFeature)
323
320
if hasattr(self, 'info'):
324
os.mkdir(self.info['directory'])
325
os.chdir(self.info['directory'])
326
msgeditor._create_temp_file_with_commit_template('infotext')
321
tmpdir = self.info['directory']
323
# Force the creation of temp file in a directory whose name
324
# requires some encoding support
325
msgeditor._create_temp_file_with_commit_template('infotext',
328
328
raise TestNotApplicable('Test run elsewhere with non-ascii data.')
336
336
self.assertFileEqual('', msgfilename)
338
338
def test_unsupported_encoding_commit_message(self):
339
old_env = osutils.set_or_unset_env('LANG', 'C')
341
# LANG env variable has no effect on Windows
342
# but some characters anyway cannot be represented
343
# in default user encoding
344
char = probe_bad_non_ascii(osutils.get_user_encoding())
346
raise TestSkipped('Cannot find suitable non-ascii character '
347
'for user_encoding (%s)' % osutils.get_user_encoding())
349
self.make_fake_editor(message=char)
351
working_tree = self.make_uncommitted_tree()
352
self.assertRaises(errors.BadCommitMessageEncoding,
353
msgeditor.edit_commit_message, '')
355
osutils.set_or_unset_env('LANG', old_env)
339
self.overrideEnv('LANG', 'C')
340
# LANG env variable has no effect on Windows
341
# but some characters anyway cannot be represented
342
# in default user encoding
343
char = probe_bad_non_ascii(osutils.get_user_encoding())
345
self.skipTest('Cannot find suitable non-ascii character '
346
'for user_encoding (%s)' % osutils.get_user_encoding())
348
self.make_fake_editor(message=char)
350
working_tree = self.make_uncommitted_tree()
351
self.assertRaises(msgeditor.BadCommitMessageEncoding,
352
msgeditor.edit_commit_message, '')
354
def test_set_commit_message_no_hooks(self):
355
commit_obj = commit.Commit()
357
msgeditor.set_commit_message(commit_obj))
359
def test_set_commit_message_hook(self):
360
msgeditor.hooks.install_named_hook("set_commit_message",
361
lambda commit_obj, existing_message: "save me some typing\n", None)
362
commit_obj = commit.Commit()
363
self.assertEqual("save me some typing\n",
364
msgeditor.set_commit_message(commit_obj))
357
366
def test_generate_commit_message_template_no_hooks(self):
358
367
commit_obj = commit.Commit()
376
385
raise TestNotApplicable("Workarounds for windows only")
377
386
import subprocess, errno
378
387
ERROR_BAD_EXE_FORMAT = 193
379
file("textfile.txt", "w").close()
388
open("textfile.txt", "w").close()
380
389
e = self.assertRaises(WindowsError, subprocess.call, "textfile.txt")
381
# Python2.4 used the 'winerror' as the errno, which confuses a lot of
382
# our error trapping code. Make sure that we understand the mapping
384
if sys.version_info >= (2, 5):
385
self.assertEqual(e.errno, errno.ENOEXEC)
386
self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)
388
self.assertEqual(e.errno, ERROR_BAD_EXE_FORMAT)
390
self.assertEqual(e.errno, errno.ENOEXEC)
391
self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)