1
# Copyright (C) 2005-2011 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.msgeditor import (
32
make_commit_message_template_encoded,
33
edit_commit_message_encoded
35
from bzrlib.tests import (
38
TestCaseWithTransport,
45
from bzrlib.tests.EncodingAdapter import encoding_scenarios
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
return multiply_tests(to_adapt, encoding_scenarios, result)
56
class MsgEditorTest(TestCaseWithTransport):
58
def make_uncommitted_tree(self):
59
"""Build a branch with uncommitted unicode named changes in the cwd."""
60
working_tree = self.make_branch_and_tree('.')
61
b = working_tree.branch
62
filename = u'hell\u00d8'
64
self.build_tree_contents([(filename, 'contents of hello')])
65
except UnicodeEncodeError:
66
raise TestSkipped("can't build unicode working tree in "
67
"filesystem encoding %s" % sys.getfilesystemencoding())
68
working_tree.add(filename)
71
def test_commit_template(self):
72
"""Test building a commit message template"""
73
working_tree = self.make_uncommitted_tree()
74
template = msgeditor.make_commit_message_template(working_tree,
76
self.assertEqualDiff(template,
82
def make_multiple_pending_tree(self):
83
config.GlobalStack().set('email', 'Bilbo Baggins <bb@hobbit.net>')
84
tree = self.make_branch_and_tree('a')
85
tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
86
tree2 = tree.bzrdir.clone('b').open_workingtree()
87
tree.commit('Minor tweak.', timestamp=1231977840, timezone=0)
88
tree2.commit('Feature X work.', timestamp=1233186240, timezone=0)
89
tree3 = tree2.bzrdir.clone('c').open_workingtree()
90
tree2.commit('Feature X finished.', timestamp=1233187680, timezone=0)
91
tree3.commit('Feature Y, based on initial X work.',
92
timestamp=1233285960, timezone=0)
93
tree.merge_from_branch(tree2.branch)
94
tree.merge_from_branch(tree3.branch, force=True)
97
def test_commit_template_pending_merges(self):
98
"""Test building a commit message template when there are pending
99
merges. The commit message should show all pending merge revisions,
100
as does 'status -v', not only the merge tips.
102
working_tree = self.make_multiple_pending_tree()
103
template = msgeditor.make_commit_message_template(working_tree, None)
104
self.assertEqualDiff(template,
107
Bilbo Baggins 2009-01-29 Feature X finished.
108
Bilbo Baggins 2009-01-28 Feature X work.
109
Bilbo Baggins 2009-01-30 Feature Y, based on initial X work.
112
def test_commit_template_encoded(self):
113
"""Test building a commit message template"""
114
working_tree = self.make_uncommitted_tree()
115
template = make_commit_message_template_encoded(working_tree,
117
output_encoding='utf8')
118
self.assertEqualDiff(template,
125
def test_commit_template_and_diff(self):
126
"""Test building a commit message template"""
127
working_tree = self.make_uncommitted_tree()
128
template = make_commit_message_template_encoded(working_tree,
131
output_encoding='utf8')
137
self.assertTrue(u"""\
140
""".encode('utf8') in template)
142
def make_do_nothing_editor(self, basename='fed'):
143
if sys.platform == "win32":
144
name = basename + '.bat'
146
f.write('@rem dummy fed')
150
name = basename + '.sh'
152
f.write('#!/bin/sh\n')
157
def test_run_editor(self):
158
self.overrideEnv('BZR_EDITOR', self.make_do_nothing_editor())
159
self.assertEqual(True, msgeditor._run_editor(''),
160
'Unable to run dummy fake editor')
162
def test_parse_editor_name(self):
163
"""Correctly interpret names with spaces.
165
See <https://bugs.launchpad.net/bzr/+bug/220331>
167
self.overrideEnv('BZR_EDITOR',
168
'"%s"' % self.make_do_nothing_editor('name with spaces'))
169
self.assertEqual(True, msgeditor._run_editor('a_filename'))
171
def make_fake_editor(self, message='test message from fed\\n'):
172
"""Set up environment so that an editor will be a known script.
174
Sets up BZR_EDITOR so that if an editor is spawned it will run a
175
script that just adds a known message to the start of the file.
177
f = file('fed.py', 'wb')
178
f.write('#!%s\n' % sys.executable)
182
if len(sys.argv) == 2:
193
if sys.platform == "win32":
194
# [win32] make batch file and set BZR_EDITOR
195
f = file('fed.bat', 'w')
199
""" % sys.executable)
201
self.overrideEnv('BZR_EDITOR', 'fed.bat')
203
# [non-win32] make python script executable and set BZR_EDITOR
204
os.chmod('fed.py', 0755)
205
self.overrideEnv('BZR_EDITOR', './fed.py')
207
def test_edit_commit_message(self):
208
working_tree = self.make_uncommitted_tree()
209
self.make_fake_editor()
211
mutter('edit_commit_message without infotext')
212
self.assertEqual('test message from fed\n',
213
msgeditor.edit_commit_message(''))
215
mutter('edit_commit_message with ascii string infotext')
216
self.assertEqual('test message from fed\n',
217
msgeditor.edit_commit_message('spam'))
219
mutter('edit_commit_message with unicode infotext')
220
self.assertEqual('test message from fed\n',
221
msgeditor.edit_commit_message(u'\u1234'))
223
tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
224
self.assertEqual('test message from fed\n', tmpl)
226
def test_start_message(self):
227
self.make_uncommitted_tree()
228
self.make_fake_editor()
229
self.assertEqual('test message from fed\nstart message\n',
230
msgeditor.edit_commit_message('',
231
start_message='start message\n'))
232
self.assertEqual('test message from fed\n',
233
msgeditor.edit_commit_message('',
236
def test_deleted_commit_message(self):
237
working_tree = self.make_uncommitted_tree()
239
if sys.platform == 'win32':
240
editor = 'cmd.exe /c del'
243
self.overrideEnv('BZR_EDITOR', editor)
245
self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
247
def test__get_editor(self):
248
self.overrideEnv('BZR_EDITOR', 'bzr_editor')
249
self.overrideEnv('VISUAL', 'visual')
250
self.overrideEnv('EDITOR', 'editor')
252
conf = config.GlobalStack()
253
conf.store._load_from_string('[DEFAULT]\neditor = config_editor\n')
255
editors = list(msgeditor._get_editor())
256
editors = [editor for (editor, cfg_src) in editors]
258
self.assertEqual(['bzr_editor', 'config_editor', 'visual', 'editor'],
261
if sys.platform == 'win32':
262
self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
264
self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe'],
268
def test__run_editor_EACCES(self):
269
"""If running a configured editor raises EACESS, the user is warned."""
270
self.overrideEnv('BZR_EDITOR', 'eacces.py')
271
f = file('eacces.py', 'wb')
272
f.write('# Not a real editor')
274
# Make the fake editor unreadable (and unexecutable)
275
os.chmod('eacces.py', 0)
276
# Set $EDITOR so that _run_editor will terminate before trying real
278
self.overrideEnv('EDITOR', self.make_do_nothing_editor())
279
# Call _run_editor, capturing mutter.warning calls.
283
warnings.append(args[0] % args[1:])
285
warnings.append(args[0])
286
_warning = trace.warning
287
trace.warning = warning
289
msgeditor._run_editor('')
291
trace.warning = _warning
292
self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
294
def test__create_temp_file_with_commit_template(self):
295
# check that commit template written properly
296
# and has platform native line-endings (CRLF on win32)
297
create_file = msgeditor._create_temp_file_with_commit_template
298
msgfilename, hasinfo = create_file('infotext','----','start message')
299
self.assertNotEqual(None, msgfilename)
300
self.assertTrue(hasinfo)
301
expected = os.linesep.join(['start message',
307
self.assertFileEqual(expected, msgfilename)
309
def test__create_temp_file_with_commit_template_in_unicode_dir(self):
310
self.requireFeature(features.UnicodeFilenameFeature)
311
if hasattr(self, 'info'):
312
tmpdir = self.info['directory']
314
# Force the creation of temp file in a directory whose name
315
# requires some encoding support
316
msgeditor._create_temp_file_with_commit_template('infotext',
319
raise TestNotApplicable('Test run elsewhere with non-ascii data.')
321
def test__create_temp_file_with_empty_commit_template(self):
323
create_file = msgeditor._create_temp_file_with_commit_template
324
msgfilename, hasinfo = create_file('')
325
self.assertNotEqual(None, msgfilename)
326
self.assertFalse(hasinfo)
327
self.assertFileEqual('', msgfilename)
329
def test_unsupported_encoding_commit_message(self):
330
self.overrideEnv('LANG', 'C')
331
# LANG env variable has no effect on Windows
332
# but some characters anyway cannot be represented
333
# in default user encoding
334
char = probe_bad_non_ascii(osutils.get_user_encoding())
336
raise TestSkipped('Cannot find suitable non-ascii character '
337
'for user_encoding (%s)' % osutils.get_user_encoding())
339
self.make_fake_editor(message=char)
341
working_tree = self.make_uncommitted_tree()
342
self.assertRaises(errors.BadCommitMessageEncoding,
343
msgeditor.edit_commit_message, '')
345
def test_set_commit_message_no_hooks(self):
346
commit_obj = commit.Commit()
348
msgeditor.set_commit_message(commit_obj))
350
def test_set_commit_message_hook(self):
351
msgeditor.hooks.install_named_hook("set_commit_message",
352
lambda commit_obj, existing_message: "save me some typing\n", None)
353
commit_obj = commit.Commit()
354
self.assertEquals("save me some typing\n",
355
msgeditor.set_commit_message(commit_obj))
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
self.assertEqual(e.errno, errno.ENOEXEC)
382
self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)
added
removed
bzrlib/tests/test_msgeditor.py
