1
# Copyright (C) 2005 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Test commit message editor.
31
from bzrlib.branch import Branch
32
from bzrlib.config import ensure_config_dir_exists, config_filename
33
from bzrlib.msgeditor import (
34
make_commit_message_template_encoded,
35
edit_commit_message_encoded
37
from bzrlib.tests import (
41
TestCaseWithTransport,
45
from bzrlib.tests.EncodingAdapter import EncodingTestAdapter
46
from bzrlib.trace import mutter
49
def load_tests(standard_tests, module, loader):
50
"""Parameterize the test for tempfile creation with different encodings."""
51
to_adapt, result = split_suite_by_re(standard_tests,
52
"test__create_temp_file_with_commit_template_in_unicode_dir")
53
for test in iter_suite_tests(to_adapt):
54
result.addTests(EncodingTestAdapter().adapt(test))
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)
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
# Test that _get_editor can return a decent list of items
241
bzr_editor = os.environ.get('BZR_EDITOR')
242
visual = os.environ.get('VISUAL')
243
editor = os.environ.get('EDITOR')
245
os.environ['BZR_EDITOR'] = 'bzr_editor'
246
os.environ['VISUAL'] = 'visual'
247
os.environ['EDITOR'] = 'editor'
249
ensure_config_dir_exists()
250
f = open(config_filename(), 'wb')
251
f.write('editor = config_editor\n')
254
editors = list(msgeditor._get_editor())
255
editors = [editor for (editor, cfg_src) in editors]
257
self.assertEqual(['bzr_editor', 'config_editor', 'visual',
258
'editor'], editors[:4])
260
if sys.platform == 'win32':
261
self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
263
self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano',
267
# Restore the environment
268
if bzr_editor is None:
269
del os.environ['BZR_EDITOR']
271
os.environ['BZR_EDITOR'] = bzr_editor
273
del os.environ['VISUAL']
275
os.environ['VISUAL'] = visual
277
del os.environ['EDITOR']
279
os.environ['EDITOR'] = editor
281
def test__run_editor_EACCES(self):
282
"""If running a configured editor raises EACESS, the user is warned."""
283
os.environ['BZR_EDITOR'] = 'eacces.py'
284
f = file('eacces.py', 'wb')
285
f.write('# Not a real editor')
287
# Make the fake editor unreadable (and unexecutable)
288
os.chmod('eacces.py', 0)
289
# Set $EDITOR so that _run_editor will terminate before trying real
291
os.environ['EDITOR'] = self.make_do_nothing_editor()
292
# Call _run_editor, capturing mutter.warning calls.
295
warnings.append(args[0] % args[1:])
296
_warning = trace.warning
297
trace.warning = warning
299
msgeditor._run_editor('')
301
trace.warning = _warning
302
self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
304
def test__create_temp_file_with_commit_template(self):
305
# check that commit template written properly
306
# and has platform native line-endings (CRLF on win32)
307
create_file = msgeditor._create_temp_file_with_commit_template
308
msgfilename, hasinfo = create_file('infotext','----','start message')
309
self.assertNotEqual(None, msgfilename)
310
self.assertTrue(hasinfo)
311
expected = os.linesep.join(['start message',
317
self.assertFileEqual(expected, msgfilename)
319
def test__create_temp_file_with_commit_template_in_unicode_dir(self):
320
self.requireFeature(tests.UnicodeFilenameFeature)
321
if hasattr(self, 'info'):
322
os.mkdir(self.info['directory'])
323
os.chdir(self.info['directory'])
324
msgeditor._create_temp_file_with_commit_template('infotext')
326
raise TestNotApplicable('Test run elsewhere with non-ascii data.')
328
def test__create_temp_file_with_empty_commit_template(self):
330
create_file = msgeditor._create_temp_file_with_commit_template
331
msgfilename, hasinfo = create_file('')
332
self.assertNotEqual(None, msgfilename)
333
self.assertFalse(hasinfo)
334
self.assertFileEqual('', msgfilename)
336
def test_unsupported_encoding_commit_message(self):
337
old_env = osutils.set_or_unset_env('LANG', 'C')
339
# LANG env variable has no effect on Windows
340
# but some characters anyway cannot be represented
341
# in default user encoding
342
char = probe_bad_non_ascii(osutils.get_user_encoding())
344
raise TestSkipped('Cannot find suitable non-ascii character '
345
'for user_encoding (%s)' % osutils.get_user_encoding())
347
self.make_fake_editor(message=char)
349
working_tree = self.make_uncommitted_tree()
350
self.assertRaises(errors.BadCommitMessageEncoding,
351
msgeditor.edit_commit_message, '')
353
osutils.set_or_unset_env('LANG', old_env)
355
def test_generate_commit_message_template_no_hooks(self):
356
commit_obj = commit.Commit()
358
msgeditor.generate_commit_message_template(commit_obj))
360
def test_generate_commit_message_template_hook(self):
361
def restoreDefaults():
362
msgeditor.hooks['commit_message_template'] = []
363
self.addCleanup(restoreDefaults)
364
msgeditor.hooks.install_named_hook("commit_message_template",
365
lambda commit_obj, msg: "save me some typing\n", None)
366
commit_obj = commit.Commit()
367
self.assertEquals("save me some typing\n",
368
msgeditor.generate_commit_message_template(commit_obj))
added
removed
bzrlib/tests/test_msgeditor.py
