1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
# Copyright (C) 2005 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Test commit message editor.
"""
import os
import sys
from bzrlib.branch import Branch
from bzrlib.config import ensure_config_dir_exists, config_filename
import bzrlib.msgeditor
from bzrlib.tests import TestCaseWithTransport, TestSkipped
from bzrlib.trace import mutter
class MsgEditorTest(TestCaseWithTransport):
def make_uncommitted_tree(self):
"""Build a branch with uncommitted unicode named changes in the cwd."""
working_tree = self.make_branch_and_tree('.')
b = working_tree.branch
filename = u'hell\u00d8'
try:
self.build_tree_contents([(filename, 'contents of hello')])
except UnicodeEncodeError:
raise TestSkipped("can't build unicode working tree in "
"filesystem encoding %s" % sys.getfilesystemencoding())
working_tree.add(filename)
return working_tree
def test_commit_template(self):
"""Test building a commit message template"""
working_tree = self.make_uncommitted_tree()
template = bzrlib.msgeditor.make_commit_message_template(working_tree, None)
self.assertEqualDiff(template,
u"""\
added:
hell\u00d8
""")
def setUp(self):
super(MsgEditorTest, self).setUp()
self._bzr_editor = os.environ.get('BZR_EDITOR', None)
def tearDown(self):
if self._bzr_editor is not None:
os.environ['BZR_EDITOR'] = self._bzr_editor
else:
if os.environ.get('BZR_EDITOR', None) is not None:
del os.environ['BZR_EDITOR']
super(MsgEditorTest, self).tearDown()
def test_run_editor(self):
if sys.platform == "win32":
f = file('fed.bat', 'w')
f.write('@rem dummy fed')
f.close()
os.environ['BZR_EDITOR'] = 'fed.bat'
else:
f = file('fed.sh', 'wb')
f.write('#!/bin/sh\n')
f.close()
os.chmod('fed.sh', 0755)
os.environ['BZR_EDITOR'] = './fed.sh'
self.assertEqual(True, bzrlib.msgeditor._run_editor(''),
'Unable to run dummy fake editor')
def make_fake_editor(self):
"""Set up environment so that an editor will be a known script.
Sets up BZR_EDITOR so that if an editor is spawned it will run a
script that just adds a known message to the start of the file.
"""
f = file('fed.py', 'wb')
f.write('#!%s\n' % sys.executable)
f.write("""\
import sys
if len(sys.argv) == 2:
fn = sys.argv[1]
f = file(fn, 'rb')
s = f.read()
f.close()
f = file(fn, 'wb')
f.write('test message from fed\\n')
f.write(s)
f.close()
""")
f.close()
if sys.platform == "win32":
# [win32] make batch file and set BZR_EDITOR
f = file('fed.bat', 'w')
f.write("""\
@echo off
"%s" fed.py %%1
""" % sys.executable)
f.close()
os.environ['BZR_EDITOR'] = 'fed.bat'
else:
# [non-win32] make python script executable and set BZR_EDITOR
os.chmod('fed.py', 0755)
os.environ['BZR_EDITOR'] = './fed.py'
def test_edit_commit_message(self):
working_tree = self.make_uncommitted_tree()
self.make_fake_editor()
mutter('edit_commit_message without infotext')
self.assertEqual('test message from fed\n',
bzrlib.msgeditor.edit_commit_message(''))
mutter('edit_commit_message with unicode infotext')
self.assertEqual('test message from fed\n',
bzrlib.msgeditor.edit_commit_message(u'\u1234'))
def test_start_message(self):
self.make_uncommitted_tree()
self.make_fake_editor()
self.assertEqual('test message from fed\nstart message\n',
bzrlib.msgeditor.edit_commit_message('',
start_message='start message\n'))
self.assertEqual('test message from fed\n',
bzrlib.msgeditor.edit_commit_message('',
start_message=''))
def test_deleted_commit_message(self):
working_tree = self.make_uncommitted_tree()
if sys.platform == 'win32':
os.environ['BZR_EDITOR'] = 'cmd.exe /c del'
else:
os.environ['BZR_EDITOR'] = 'rm'
self.assertRaises((IOError, OSError), bzrlib.msgeditor.edit_commit_message, '')
def test__get_editor(self):
# Test that _get_editor can return a decent list of items
bzr_editor = os.environ.get('BZR_EDITOR')
visual = os.environ.get('VISUAL')
editor = os.environ.get('EDITOR')
try:
os.environ['BZR_EDITOR'] = 'bzr_editor'
os.environ['VISUAL'] = 'visual'
os.environ['EDITOR'] = 'editor'
ensure_config_dir_exists()
f = open(config_filename(), 'wb')
f.write('editor = config_editor\n')
f.close()
editors = list(bzrlib.msgeditor._get_editor())
self.assertEqual(['bzr_editor', 'config_editor', 'visual',
'editor'], editors[:4])
if sys.platform == 'win32':
self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
else:
self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano',
'joe'], editors[4:])
finally:
# Restore the environment
if bzr_editor is None:
del os.environ['BZR_EDITOR']
else:
os.environ['BZR_EDITOR'] = bzr_editor
if visual is None:
del os.environ['VISUAL']
else:
os.environ['VISUAL'] = visual
if editor is None:
del os.environ['EDITOR']
else:
os.environ['EDITOR'] = editor
def test__create_temp_file_with_commit_template(self):
# check that commit template written properly
# and has platform native line-endings (CRLF on win32)
create_file = bzrlib.msgeditor._create_temp_file_with_commit_template
msgfilename, hasinfo = create_file('infotext','----','start message')
self.assertNotEqual(None, msgfilename)
self.assertTrue(hasinfo)
expected = os.linesep.join(['start message',
'',
'',
'----',
'',
'infotext'])
self.assertFileEqual(expected, msgfilename)
def test__create_temp_file_with_empty_commit_template(self):
# empty file
create_file = bzrlib.msgeditor._create_temp_file_with_commit_template
msgfilename, hasinfo = create_file('')
self.assertNotEqual(None, msgfilename)
self.assertFalse(hasinfo)
self.assertFileEqual('', msgfilename)
|