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.
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 (
39
TestCaseWithTransport,
46
from bzrlib.tests.EncodingAdapter import encoding_scenarios
47
from bzrlib.trace import mutter
50
def load_tests(standard_tests, module, loader):
51
"""Parameterize the test for tempfile creation with different encodings."""
52
to_adapt, result = split_suite_by_re(standard_tests,
53
"test__create_temp_file_with_commit_template_in_unicode_dir")
54
return multiply_tests(to_adapt, encoding_scenarios, result)
57
class MsgEditorTest(TestCaseWithTransport):
59
def make_uncommitted_tree(self):
60
"""Build a branch with uncommitted unicode named changes in the cwd."""
61
working_tree = self.make_branch_and_tree('.')
62
b = working_tree.branch
63
filename = u'hell\u00d8'
65
self.build_tree_contents([(filename, 'contents of hello')])
66
except UnicodeEncodeError:
67
raise TestSkipped("can't build unicode working tree in "
68
"filesystem encoding %s" % sys.getfilesystemencoding())
69
working_tree.add(filename)
72
def test_commit_template(self):
73
"""Test building a commit message template"""
74
working_tree = self.make_uncommitted_tree()
75
template = msgeditor.make_commit_message_template(working_tree,
77
self.assertEqualDiff(template,
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
def test_commit_template_encoded(self):
116
"""Test building a commit message template"""
117
working_tree = self.make_uncommitted_tree()
118
template = make_commit_message_template_encoded(working_tree,
120
output_encoding='utf8')
121
self.assertEqualDiff(template,
128
def test_commit_template_and_diff(self):
129
"""Test building a commit message template"""
130
working_tree = self.make_uncommitted_tree()
131
template = make_commit_message_template_encoded(working_tree,
134
output_encoding='utf8')
140
self.assertTrue(u"""\
143
""".encode('utf8') in template)
145
def make_do_nothing_editor(self):
146
if sys.platform == "win32":
147
f = file('fed.bat', 'w')
148
f.write('@rem dummy fed')
152
f = file('fed.sh', 'wb')
153
f.write('#!/bin/sh\n')
155
os.chmod('fed.sh', 0755)
158
def test_run_editor(self):
159
os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
160
self.assertEqual(True, msgeditor._run_editor(''),
161
'Unable to run dummy fake editor')
163
def make_fake_editor(self, message='test message from fed\\n'):
164
"""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
167
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)
174
if len(sys.argv) == 2:
185
if sys.platform == "win32":
186
# [win32] make batch file and set BZR_EDITOR
187
f = file('fed.bat', 'w')
191
""" % sys.executable)
193
os.environ['BZR_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
def test_edit_commit_message(self):
200
working_tree = self.make_uncommitted_tree()
201
self.make_fake_editor()
203
mutter('edit_commit_message without infotext')
204
self.assertEqual('test message from fed\n',
205
msgeditor.edit_commit_message(''))
207
mutter('edit_commit_message with ascii string infotext')
208
self.assertEqual('test message from fed\n',
209
msgeditor.edit_commit_message('spam'))
211
mutter('edit_commit_message with unicode infotext')
212
self.assertEqual('test message from fed\n',
213
msgeditor.edit_commit_message(u'\u1234'))
215
tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
216
self.assertEqual('test message from fed\n', tmpl)
218
def test_start_message(self):
219
self.make_uncommitted_tree()
220
self.make_fake_editor()
221
self.assertEqual('test message from fed\nstart message\n',
222
msgeditor.edit_commit_message('',
223
start_message='start message\n'))
224
self.assertEqual('test message from fed\n',
225
msgeditor.edit_commit_message('',
228
def test_deleted_commit_message(self):
229
working_tree = self.make_uncommitted_tree()
231
if sys.platform == 'win32':
232
os.environ['BZR_EDITOR'] = 'cmd.exe /c del'
234
os.environ['BZR_EDITOR'] = 'rm'
236
self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
238
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
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
def test__create_temp_file_with_commit_template(self):
307
# check that commit template written properly
308
# and has platform native line-endings (CRLF on win32)
309
create_file = msgeditor._create_temp_file_with_commit_template
310
msgfilename, hasinfo = create_file('infotext','----','start message')
311
self.assertNotEqual(None, msgfilename)
312
self.assertTrue(hasinfo)
313
expected = os.linesep.join(['start message',
319
self.assertFileEqual(expected, msgfilename)
321
def test__create_temp_file_with_commit_template_in_unicode_dir(self):
322
self.requireFeature(tests.UnicodeFilenameFeature)
323
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')
328
raise TestNotApplicable('Test run elsewhere with non-ascii data.')
330
def test__create_temp_file_with_empty_commit_template(self):
332
create_file = msgeditor._create_temp_file_with_commit_template
333
msgfilename, hasinfo = create_file('')
334
self.assertNotEqual(None, msgfilename)
335
self.assertFalse(hasinfo)
336
self.assertFileEqual('', msgfilename)
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)
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)
added
removed
bzrlib/tests/test_msgeditor.py
