1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
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
13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Test commit message editor.
35
33
edit_commit_message_encoded
37
35
from bzrlib.tests import (
39
39
TestCaseWithTransport,
46
from bzrlib.tests.EncodingAdapter import encoding_scenarios
43
from bzrlib.tests.EncodingAdapter import EncodingTestAdapter
47
44
from bzrlib.trace import mutter
51
48
"""Parameterize the test for tempfile creation with different encodings."""
52
49
to_adapt, result = split_suite_by_re(standard_tests,
53
50
"test__create_temp_file_with_commit_template_in_unicode_dir")
54
return multiply_tests(to_adapt, encoding_scenarios, result)
51
for test in iter_suite_tests(to_adapt):
52
result.addTests(EncodingTestAdapter().adapt(test))
57
56
class MsgEditorTest(TestCaseWithTransport):
68
67
"filesystem encoding %s" % sys.getfilesystemencoding())
69
68
working_tree.add(filename)
70
69
return working_tree
72
71
def test_commit_template(self):
73
72
"""Test building a commit message template"""
74
73
working_tree = self.make_uncommitted_tree()
83
def make_multiple_pending_tree(self):
84
from bzrlib import config
85
config.GlobalConfig().set_user_option('email',
86
'Bilbo Baggins <bb@hobbit.net>')
87
tree = self.make_branch_and_tree('a')
88
tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
89
tree2 = tree.bzrdir.clone('b').open_workingtree()
90
tree.commit('Minor tweak.', timestamp=1231977840, timezone=0)
91
tree2.commit('Feature X work.', timestamp=1233186240, timezone=0)
92
tree3 = tree2.bzrdir.clone('c').open_workingtree()
93
tree2.commit('Feature X finished.', timestamp=1233187680, timezone=0)
94
tree3.commit('Feature Y, based on initial X work.',
95
timestamp=1233285960, timezone=0)
96
tree.merge_from_branch(tree2.branch)
97
tree.merge_from_branch(tree3.branch, force=True)
100
def test_commit_template_pending_merges(self):
101
"""Test building a commit message template when there are pending
102
merges. The commit message should show all pending merge revisions,
103
as does 'status -v', not only the merge tips.
105
working_tree = self.make_multiple_pending_tree()
106
template = msgeditor.make_commit_message_template(working_tree, None)
107
self.assertEqualDiff(template,
110
Bilbo Baggins 2009-01-29 Feature X finished.
111
Bilbo Baggins 2009-01-28 Feature X work.
112
Bilbo Baggins 2009-01-30 Feature Y, based on initial X work.
115
82
def test_commit_template_encoded(self):
116
83
"""Test building a commit message template"""
117
84
working_tree = self.make_uncommitted_tree()
143
110
""".encode('utf8') in template)
145
def make_do_nothing_editor(self):
112
def test_run_editor(self):
146
113
if sys.platform == "win32":
147
114
f = file('fed.bat', 'w')
148
115
f.write('@rem dummy fed')
117
os.environ['BZR_EDITOR'] = 'fed.bat'
152
119
f = file('fed.sh', 'wb')
153
120
f.write('#!/bin/sh\n')
155
122
os.chmod('fed.sh', 0755)
123
os.environ['BZR_EDITOR'] = './fed.sh'
158
def test_run_editor(self):
159
os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
160
125
self.assertEqual(True, msgeditor._run_editor(''),
161
126
'Unable to run dummy fake editor')
253
218
editors = list(msgeditor._get_editor())
254
editors = [editor for (editor, cfg_src) in editors]
256
220
self.assertEqual(['bzr_editor', 'config_editor', 'visual',
257
221
'editor'], editors[:4])
278
242
os.environ['EDITOR'] = editor
280
def test__run_editor_EACCES(self):
281
"""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')
286
# Make the fake editor unreadable (and unexecutable)
287
os.chmod('eacces.py', 0)
288
# Set $EDITOR so that _run_editor will terminate before trying real
290
os.environ['EDITOR'] = self.make_do_nothing_editor()
291
# Call _run_editor, capturing mutter.warning calls.
295
warnings.append(args[0] % args[1:])
297
warnings.append(args[0])
298
_warning = trace.warning
299
trace.warning = warning
301
msgeditor._run_editor('')
303
trace.warning = _warning
304
self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
306
244
def test__create_temp_file_with_commit_template(self):
307
245
# check that commit template written properly
308
246
# and has platform native line-endings (CRLF on win32)
319
257
self.assertFileEqual(expected, msgfilename)
321
259
def test__create_temp_file_with_commit_template_in_unicode_dir(self):
322
self.requireFeature(tests.UnicodeFilenameFeature)
260
from bzrlib.tests.test_diff import UnicodeFilename
261
self.requireFeature(UnicodeFilename)
323
262
if hasattr(self, 'info'):
324
263
os.mkdir(self.info['directory'])
325
264
os.chdir(self.info['directory'])
341
280
# LANG env variable has no effect on Windows
342
281
# but some characters anyway cannot be represented
343
282
# in default user encoding
344
char = probe_bad_non_ascii(osutils.get_user_encoding())
283
char = probe_bad_non_ascii(bzrlib.user_encoding)
346
285
raise TestSkipped('Cannot find suitable non-ascii character '
347
'for user_encoding (%s)' % osutils.get_user_encoding())
286
'for user_encoding (%s)' % bzrlib.user_encoding)
349
288
self.make_fake_editor(message=char)
353
292
msgeditor.edit_commit_message, '')
355
294
osutils.set_or_unset_env('LANG', old_env)
357
def test_generate_commit_message_template_no_hooks(self):
358
commit_obj = commit.Commit()
360
msgeditor.generate_commit_message_template(commit_obj))
362
def test_generate_commit_message_template_hook(self):
363
msgeditor.hooks.install_named_hook("commit_message_template",
364
lambda commit_obj, msg: "save me some typing\n", None)
365
commit_obj = commit.Commit()
366
self.assertEquals("save me some typing\n",
367
msgeditor.generate_commit_message_template(commit_obj))
370
# GZ 2009-11-17: This wants moving to osutils when the errno checking code is
371
class TestPlatformErrnoWorkarounds(TestCaseInTempDir):
372
"""Ensuring workarounds enshrined in code actually serve a purpose"""
374
def test_subprocess_call_bad_file(self):
375
if sys.platform != "win32":
376
raise TestNotApplicable("Workarounds for windows only")
377
import subprocess, errno
378
ERROR_BAD_EXE_FORMAT = 193
379
file("textfile.txt", "w").close()
380
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)