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.
32
from bzrlib.msgeditor import (
33
make_commit_message_template_encoded,
34
edit_commit_message_encoded
36
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, basename='fed'):
146
if sys.platform == "win32":
147
name = basename + '.bat'
149
f.write('@rem dummy fed')
153
name = basename + '.sh'
155
f.write('#!/bin/sh\n')
160
def test_run_editor(self):
161
self.overrideEnv('BZR_EDITOR', self.make_do_nothing_editor())
162
self.assertEqual(True, msgeditor._run_editor(''),
163
'Unable to run dummy fake editor')
165
def test_parse_editor_name(self):
166
"""Correctly interpret names with spaces.
168
See <https://bugs.launchpad.net/bzr/+bug/220331>
170
self.overrideEnv('BZR_EDITOR',
171
'"%s"' % self.make_do_nothing_editor('name with spaces'))
172
self.assertEqual(True, msgeditor._run_editor('a_filename'))
174
def make_fake_editor(self, message='test message from fed\\n'):
175
"""Set up environment so that an editor will be a known script.
177
Sets up BZR_EDITOR so that if an editor is spawned it will run a
178
script that just adds a known message to the start of the file.
180
f = file('fed.py', 'wb')
181
f.write('#!%s\n' % sys.executable)
185
if len(sys.argv) == 2:
196
if sys.platform == "win32":
197
# [win32] make batch file and set BZR_EDITOR
198
f = file('fed.bat', 'w')
202
""" % sys.executable)
204
self.overrideEnv('BZR_EDITOR', 'fed.bat')
206
# [non-win32] make python script executable and set BZR_EDITOR
207
os.chmod('fed.py', 0755)
208
self.overrideEnv('BZR_EDITOR', './fed.py')
210
def test_edit_commit_message(self):
211
working_tree = self.make_uncommitted_tree()
212
self.make_fake_editor()
214
mutter('edit_commit_message without infotext')
215
self.assertEqual('test message from fed\n',
216
msgeditor.edit_commit_message(''))
218
mutter('edit_commit_message with ascii string infotext')
219
self.assertEqual('test message from fed\n',
220
msgeditor.edit_commit_message('spam'))
222
mutter('edit_commit_message with unicode infotext')
223
self.assertEqual('test message from fed\n',
224
msgeditor.edit_commit_message(u'\u1234'))
226
tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
227
self.assertEqual('test message from fed\n', tmpl)
229
def test_start_message(self):
230
self.make_uncommitted_tree()
231
self.make_fake_editor()
232
self.assertEqual('test message from fed\nstart message\n',
233
msgeditor.edit_commit_message('',
234
start_message='start message\n'))
235
self.assertEqual('test message from fed\n',
236
msgeditor.edit_commit_message('',
239
def test_deleted_commit_message(self):
240
working_tree = self.make_uncommitted_tree()
242
if sys.platform == 'win32':
243
editor = 'cmd.exe /c del'
246
self.overrideEnv('BZR_EDITOR', editor)
248
self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
250
def test__get_editor(self):
251
self.overrideEnv('BZR_EDITOR', 'bzr_editor')
252
self.overrideEnv('VISUAL', 'visual')
253
self.overrideEnv('EDITOR', 'editor')
255
conf = config.GlobalStack()
256
conf.store._load_from_string('[DEFAULT]\neditor = config_editor\n')
258
editors = list(msgeditor._get_editor())
259
editors = [editor for (editor, cfg_src) in editors]
261
self.assertEqual(['bzr_editor', 'config_editor', 'visual', 'editor'],
264
if sys.platform == 'win32':
265
self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
267
self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe'],
271
def test__run_editor_EACCES(self):
272
"""If running a configured editor raises EACESS, the user is warned."""
273
self.overrideEnv('BZR_EDITOR', 'eacces.py')
274
f = file('eacces.py', 'wb')
275
f.write('# Not a real editor')
277
# Make the fake editor unreadable (and unexecutable)
278
os.chmod('eacces.py', 0)
279
# Set $EDITOR so that _run_editor will terminate before trying real
281
self.overrideEnv('EDITOR', self.make_do_nothing_editor())
282
# Call _run_editor, capturing mutter.warning calls.
286
warnings.append(args[0] % args[1:])
288
warnings.append(args[0])
289
_warning = trace.warning
290
trace.warning = warning
292
msgeditor._run_editor('')
294
trace.warning = _warning
295
self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
297
def test__create_temp_file_with_commit_template(self):
298
# check that commit template written properly
299
# and has platform native line-endings (CRLF on win32)
300
create_file = msgeditor._create_temp_file_with_commit_template
301
msgfilename, hasinfo = create_file('infotext','----','start message')
302
self.assertNotEqual(None, msgfilename)
303
self.assertTrue(hasinfo)
304
expected = os.linesep.join(['start message',
310
self.assertFileEqual(expected, msgfilename)
312
def test__create_temp_file_with_commit_template_in_unicode_dir(self):
313
self.requireFeature(features.UnicodeFilenameFeature)
314
if hasattr(self, 'info'):
315
tmpdir = self.info['directory']
317
# Force the creation of temp file in a directory whose name
318
# requires some encoding support
319
msgeditor._create_temp_file_with_commit_template('infotext',
322
raise TestNotApplicable('Test run elsewhere with non-ascii data.')
324
def test__create_temp_file_with_empty_commit_template(self):
326
create_file = msgeditor._create_temp_file_with_commit_template
327
msgfilename, hasinfo = create_file('')
328
self.assertNotEqual(None, msgfilename)
329
self.assertFalse(hasinfo)
330
self.assertFileEqual('', msgfilename)
332
def test_unsupported_encoding_commit_message(self):
333
self.overrideEnv('LANG', 'C')
334
# LANG env variable has no effect on Windows
335
# but some characters anyway cannot be represented
336
# in default user encoding
337
char = probe_bad_non_ascii(osutils.get_user_encoding())
339
raise TestSkipped('Cannot find suitable non-ascii character '
340
'for user_encoding (%s)' % osutils.get_user_encoding())
342
self.make_fake_editor(message=char)
344
working_tree = self.make_uncommitted_tree()
345
self.assertRaises(errors.BadCommitMessageEncoding,
346
msgeditor.edit_commit_message, '')
348
def test_set_commit_message_no_hooks(self):
349
commit_obj = commit.Commit()
351
msgeditor.set_commit_message(commit_obj))
353
def test_set_commit_message_hook(self):
354
msgeditor.hooks.install_named_hook("set_commit_message",
355
lambda commit_obj, existing_message: "save me some typing\n", None)
356
commit_obj = commit.Commit()
357
self.assertEquals("save me some typing\n",
358
msgeditor.set_commit_message(commit_obj))
360
def test_generate_commit_message_template_no_hooks(self):
361
commit_obj = commit.Commit()
363
msgeditor.generate_commit_message_template(commit_obj))
365
def test_generate_commit_message_template_hook(self):
366
msgeditor.hooks.install_named_hook("commit_message_template",
367
lambda commit_obj, msg: "save me some typing\n", None)
368
commit_obj = commit.Commit()
369
self.assertEquals("save me some typing\n",
370
msgeditor.generate_commit_message_template(commit_obj))
373
# GZ 2009-11-17: This wants moving to osutils when the errno checking code is
374
class TestPlatformErrnoWorkarounds(TestCaseInTempDir):
375
"""Ensuring workarounds enshrined in code actually serve a purpose"""
377
def test_subprocess_call_bad_file(self):
378
if sys.platform != "win32":
379
raise TestNotApplicable("Workarounds for windows only")
380
import subprocess, errno
381
ERROR_BAD_EXE_FORMAT = 193
382
file("textfile.txt", "w").close()
383
e = self.assertRaises(WindowsError, subprocess.call, "textfile.txt")
384
self.assertEqual(e.errno, errno.ENOEXEC)
385
self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)
added
removed
bzrlib/tests/test_msgeditor.py
