1
# Copyright (C) 2005-2010 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
"""Test commit message editor.
32
from bzrlib.branch import Branch
33
from bzrlib.config import ensure_config_dir_exists, config_filename
34
from bzrlib.msgeditor import (
35
make_commit_message_template_encoded,
36
edit_commit_message_encoded
38
from bzrlib.tests import (
40
TestCaseWithTransport,
47
from bzrlib.tests.EncodingAdapter import encoding_scenarios
48
from bzrlib.trace import mutter
51
def load_tests(standard_tests, module, loader):
52
"""Parameterize the test for tempfile creation with different encodings."""
53
to_adapt, result = split_suite_by_re(standard_tests,
54
"test__create_temp_file_with_commit_template_in_unicode_dir")
55
return multiply_tests(to_adapt, encoding_scenarios, result)
58
class MsgEditorTest(TestCaseWithTransport):
60
def make_uncommitted_tree(self):
61
"""Build a branch with uncommitted unicode named changes in the cwd."""
62
working_tree = self.make_branch_and_tree('.')
63
b = working_tree.branch
64
filename = u'hell\u00d8'
66
self.build_tree_contents([(filename, 'contents of hello')])
67
except UnicodeEncodeError:
68
raise TestSkipped("can't build unicode working tree in "
69
"filesystem encoding %s" % sys.getfilesystemencoding())
70
working_tree.add(filename)
73
def test_commit_template(self):
74
"""Test building a commit message template"""
75
working_tree = self.make_uncommitted_tree()
76
template = msgeditor.make_commit_message_template(working_tree,
78
self.assertEqualDiff(template,
84
def make_multiple_pending_tree(self):
85
from bzrlib import config
86
config.GlobalConfig().set_user_option('email',
87
'Bilbo Baggins <bb@hobbit.net>')
88
tree = self.make_branch_and_tree('a')
89
tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
90
tree2 = tree.bzrdir.clone('b').open_workingtree()
91
tree.commit('Minor tweak.', timestamp=1231977840, timezone=0)
92
tree2.commit('Feature X work.', timestamp=1233186240, timezone=0)
93
tree3 = tree2.bzrdir.clone('c').open_workingtree()
94
tree2.commit('Feature X finished.', timestamp=1233187680, timezone=0)
95
tree3.commit('Feature Y, based on initial X work.',
96
timestamp=1233285960, timezone=0)
97
tree.merge_from_branch(tree2.branch)
98
tree.merge_from_branch(tree3.branch, force=True)
101
def test_commit_template_pending_merges(self):
102
"""Test building a commit message template when there are pending
103
merges. The commit message should show all pending merge revisions,
104
as does 'status -v', not only the merge tips.
106
working_tree = self.make_multiple_pending_tree()
107
template = msgeditor.make_commit_message_template(working_tree, None)
108
self.assertEqualDiff(template,
111
Bilbo Baggins 2009-01-29 Feature X finished.
112
Bilbo Baggins 2009-01-28 Feature X work.
113
Bilbo Baggins 2009-01-30 Feature Y, based on initial X work.
116
def test_commit_template_encoded(self):
117
"""Test building a commit message template"""
118
working_tree = self.make_uncommitted_tree()
119
template = make_commit_message_template_encoded(working_tree,
121
output_encoding='utf8')
122
self.assertEqualDiff(template,
129
def test_commit_template_and_diff(self):
130
"""Test building a commit message template"""
131
working_tree = self.make_uncommitted_tree()
132
template = make_commit_message_template_encoded(working_tree,
135
output_encoding='utf8')
141
self.assertTrue(u"""\
144
""".encode('utf8') in template)
146
def make_do_nothing_editor(self):
147
if sys.platform == "win32":
148
f = file('fed.bat', 'w')
149
f.write('@rem dummy fed')
153
f = file('fed.sh', 'wb')
154
f.write('#!/bin/sh\n')
156
os.chmod('fed.sh', 0755)
159
def test_run_editor(self):
160
os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
161
self.assertEqual(True, msgeditor._run_editor(''),
162
'Unable to run dummy fake editor')
164
def make_fake_editor(self, message='test message from fed\\n'):
165
"""Set up environment so that an editor will be a known script.
167
Sets up BZR_EDITOR so that if an editor is spawned it will run a
168
script that just adds a known message to the start of the file.
170
f = file('fed.py', 'wb')
171
f.write('#!%s\n' % sys.executable)
175
if len(sys.argv) == 2:
186
if sys.platform == "win32":
187
# [win32] make batch file and set BZR_EDITOR
188
f = file('fed.bat', 'w')
192
""" % sys.executable)
194
os.environ['BZR_EDITOR'] = 'fed.bat'
196
# [non-win32] make python script executable and set BZR_EDITOR
197
os.chmod('fed.py', 0755)
198
os.environ['BZR_EDITOR'] = './fed.py'
200
def test_edit_commit_message(self):
201
working_tree = self.make_uncommitted_tree()
202
self.make_fake_editor()
204
mutter('edit_commit_message without infotext')
205
self.assertEqual('test message from fed\n',
206
msgeditor.edit_commit_message(''))
208
mutter('edit_commit_message with ascii string infotext')
209
self.assertEqual('test message from fed\n',
210
msgeditor.edit_commit_message('spam'))
212
mutter('edit_commit_message with unicode infotext')
213
self.assertEqual('test message from fed\n',
214
msgeditor.edit_commit_message(u'\u1234'))
216
tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
217
self.assertEqual('test message from fed\n', tmpl)
219
def test_start_message(self):
220
self.make_uncommitted_tree()
221
self.make_fake_editor()
222
self.assertEqual('test message from fed\nstart message\n',
223
msgeditor.edit_commit_message('',
224
start_message='start message\n'))
225
self.assertEqual('test message from fed\n',
226
msgeditor.edit_commit_message('',
229
def test_deleted_commit_message(self):
230
working_tree = self.make_uncommitted_tree()
232
if sys.platform == 'win32':
233
os.environ['BZR_EDITOR'] = 'cmd.exe /c del'
235
os.environ['BZR_EDITOR'] = 'rm'
237
self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
239
def test__get_editor(self):
240
os.environ['BZR_EDITOR'] = 'bzr_editor'
241
os.environ['VISUAL'] = 'visual'
242
os.environ['EDITOR'] = 'editor'
244
conf = config.GlobalConfig.from_string('editor = config_editor\n',
247
editors = list(msgeditor._get_editor())
248
editors = [editor for (editor, cfg_src) in editors]
250
self.assertEqual(['bzr_editor', 'config_editor', 'visual', 'editor'],
253
if sys.platform == 'win32':
254
self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
256
self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe'],
260
def test__run_editor_EACCES(self):
261
"""If running a configured editor raises EACESS, the user is warned."""
262
os.environ['BZR_EDITOR'] = 'eacces.py'
263
f = file('eacces.py', 'wb')
264
f.write('# Not a real editor')
266
# Make the fake editor unreadable (and unexecutable)
267
os.chmod('eacces.py', 0)
268
# Set $EDITOR so that _run_editor will terminate before trying real
270
os.environ['EDITOR'] = self.make_do_nothing_editor()
271
# Call _run_editor, capturing mutter.warning calls.
275
warnings.append(args[0] % args[1:])
277
warnings.append(args[0])
278
_warning = trace.warning
279
trace.warning = warning
281
msgeditor._run_editor('')
283
trace.warning = _warning
284
self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
286
def test__create_temp_file_with_commit_template(self):
287
# check that commit template written properly
288
# and has platform native line-endings (CRLF on win32)
289
create_file = msgeditor._create_temp_file_with_commit_template
290
msgfilename, hasinfo = create_file('infotext','----','start message')
291
self.assertNotEqual(None, msgfilename)
292
self.assertTrue(hasinfo)
293
expected = os.linesep.join(['start message',
299
self.assertFileEqual(expected, msgfilename)
301
def test__create_temp_file_with_commit_template_in_unicode_dir(self):
302
self.requireFeature(tests.UnicodeFilenameFeature)
303
if hasattr(self, 'info'):
304
os.mkdir(self.info['directory'])
305
os.chdir(self.info['directory'])
306
msgeditor._create_temp_file_with_commit_template('infotext')
308
raise TestNotApplicable('Test run elsewhere with non-ascii data.')
310
def test__create_temp_file_with_empty_commit_template(self):
312
create_file = msgeditor._create_temp_file_with_commit_template
313
msgfilename, hasinfo = create_file('')
314
self.assertNotEqual(None, msgfilename)
315
self.assertFalse(hasinfo)
316
self.assertFileEqual('', msgfilename)
318
def test_unsupported_encoding_commit_message(self):
319
old_env = osutils.set_or_unset_env('LANG', 'C')
321
# LANG env variable has no effect on Windows
322
# but some characters anyway cannot be represented
323
# in default user encoding
324
char = probe_bad_non_ascii(osutils.get_user_encoding())
326
raise TestSkipped('Cannot find suitable non-ascii character '
327
'for user_encoding (%s)' % osutils.get_user_encoding())
329
self.make_fake_editor(message=char)
331
working_tree = self.make_uncommitted_tree()
332
self.assertRaises(errors.BadCommitMessageEncoding,
333
msgeditor.edit_commit_message, '')
335
osutils.set_or_unset_env('LANG', old_env)
337
def test_generate_commit_message_template_no_hooks(self):
338
commit_obj = commit.Commit()
340
msgeditor.generate_commit_message_template(commit_obj))
342
def test_generate_commit_message_template_hook(self):
343
msgeditor.hooks.install_named_hook("commit_message_template",
344
lambda commit_obj, msg: "save me some typing\n", None)
345
commit_obj = commit.Commit()
346
self.assertEquals("save me some typing\n",
347
msgeditor.generate_commit_message_template(commit_obj))
350
# GZ 2009-11-17: This wants moving to osutils when the errno checking code is
351
class TestPlatformErrnoWorkarounds(TestCaseInTempDir):
352
"""Ensuring workarounds enshrined in code actually serve a purpose"""
354
def test_subprocess_call_bad_file(self):
355
if sys.platform != "win32":
356
raise TestNotApplicable("Workarounds for windows only")
357
import subprocess, errno
358
ERROR_BAD_EXE_FORMAT = 193
359
file("textfile.txt", "w").close()
360
e = self.assertRaises(WindowsError, subprocess.call, "textfile.txt")
361
# Python2.4 used the 'winerror' as the errno, which confuses a lot of
362
# our error trapping code. Make sure that we understand the mapping
364
if sys.version_info >= (2, 5):
365
self.assertEqual(e.errno, errno.ENOEXEC)
366
self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)
368
self.assertEqual(e.errno, ERROR_BAD_EXE_FORMAT)
added
removed
bzrlib/tests/test_msgeditor.py
