← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_msgeditor.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-15 14:06:37 UTC
  • mto: This revision was merged to the branch mainline in revision 1926.
  • Revision ID: john@arbash-meinel.com-20060815140637-fa80ad04e689d5e4
Fix accidental import removal

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_msgeditor.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005 by Canonical Ltd
2
2
#
3
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.
 
4
# it under the terms of the GNU General Public License version 2 as published by
 
5
# the Free Software Foundation.
7
6
#
8
7
# This program is distributed in the hope that it will be useful,
9
8
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
11
#
13
12
# You should have received a copy of the GNU General Public License
14
13
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
14
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
15
 
17
16
"""Test commit message editor.
18
17
"""
20
19
import os
21
20
import sys
22
21
 
23
 
from bzrlib import (
24
 
    commit,
25
 
    errors,
26
 
    msgeditor,
27
 
    osutils,
28
 
    tests,
29
 
    trace,
30
 
    )
31
22
from bzrlib.branch import Branch
32
23
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
36
 
)
37
 
from bzrlib.tests import (
38
 
    TestCaseWithTransport,
39
 
    TestNotApplicable,
40
 
    TestSkipped,
41
 
    multiply_tests,
42
 
    probe_bad_non_ascii,
43
 
    split_suite_by_re,
44
 
    )
45
 
from bzrlib.tests.EncodingAdapter import encoding_scenarios
 
24
import bzrlib.msgeditor 
 
25
from bzrlib.tests import TestCaseWithTransport, TestSkipped
46
26
from bzrlib.trace import mutter
47
27
 
48
28
 
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)
54
 
 
55
 
 
56
29
class MsgEditorTest(TestCaseWithTransport):
57
30
 
58
31
    def make_uncommitted_tree(self):
67
40
                "filesystem encoding %s" % sys.getfilesystemencoding())
68
41
        working_tree.add(filename)
69
42
        return working_tree
70
 
 
 
43
    
71
44
    def test_commit_template(self):
72
45
        """Test building a commit message template"""
73
46
        working_tree = self.make_uncommitted_tree()
74
 
        template = msgeditor.make_commit_message_template(working_tree,
75
 
                                                                 None)
76
 
        self.assertEqualDiff(template,
77
 
u"""\
78
 
added:
79
 
  hell\u00d8
80
 
""")
81
 
 
82
 
    def make_multiple_pending_tree(self):
83
 
        from bzrlib import config
84
 
        self.thisFailsStrictLockCheck() # clone?
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)
98
 
        return tree
99
 
 
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.
104
 
        """
105
 
        working_tree = self.make_multiple_pending_tree()
106
 
        template = msgeditor.make_commit_message_template(working_tree, None)
107
 
        self.assertEqualDiff(template,
108
 
u"""\
109
 
pending merges:
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.
113
 
""")
114
 
 
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,
119
 
                                                        None,
120
 
                                                        output_encoding='utf8')
121
 
        self.assertEqualDiff(template,
122
 
u"""\
123
 
added:
124
 
  hell\u00d8
125
 
""".encode("utf8"))
126
 
 
127
 
 
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,
132
 
                                                        None,
133
 
                                                        diff=True,
134
 
                                                        output_encoding='utf8')
135
 
 
136
 
        self.assertTrue("""\
137
 
@@ -0,0 +1,1 @@
138
 
+contents of hello
139
 
""" in template)
140
 
        self.assertTrue(u"""\
141
 
added:
142
 
  hell\u00d8
143
 
""".encode('utf8') in template)
144
 
 
145
 
    def make_do_nothing_editor(self):
 
47
        template = bzrlib.msgeditor.make_commit_message_template(working_tree, None)
 
48
        self.assertEqualDiff(template,
 
49
u"""\
 
50
added:
 
51
  hell\u00d8
 
52
""")
 
53
 
 
54
    def setUp(self):
 
55
        super(MsgEditorTest, self).setUp()
 
56
        self._bzr_editor = os.environ.get('BZR_EDITOR', None)
 
57
 
 
58
    def tearDown(self):
 
59
        if self._bzr_editor != None:
 
60
            os.environ['BZR_EDITOR'] = self._bzr_editor
 
61
        else:
 
62
            if os.environ.get('BZR_EDITOR', None) != None:
 
63
                del os.environ['BZR_EDITOR']
 
64
        super(MsgEditorTest, self).tearDown()
 
65
 
 
66
    def test_run_editor(self):
146
67
        if sys.platform == "win32":
147
68
            f = file('fed.bat', 'w')
148
69
            f.write('@rem dummy fed')
149
70
            f.close()
150
 
            return 'fed.bat'
 
71
            os.environ['BZR_EDITOR'] = 'fed.bat'
151
72
        else:
152
73
            f = file('fed.sh', 'wb')
153
74
            f.write('#!/bin/sh\n')
154
75
            f.close()
155
76
            os.chmod('fed.sh', 0755)
156
 
            return './fed.sh'
 
77
            os.environ['BZR_EDITOR'] = './fed.sh'
157
78
 
158
 
    def test_run_editor(self):
159
 
        os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
160
 
        self.assertEqual(True, msgeditor._run_editor(''),
 
79
        self.assertEqual(True, bzrlib.msgeditor._run_editor(''),
161
80
                         'Unable to run dummy fake editor')
162
81
 
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.
165
 
 
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.
168
 
        """
 
82
    def test_edit_commit_message(self):
 
83
        working_tree = self.make_uncommitted_tree()
 
84
        # make fake editor
169
85
        f = file('fed.py', 'wb')
170
86
        f.write('#!%s\n' % sys.executable)
171
87
        f.write("""\
172
 
# coding=utf-8
173
88
import sys
174
89
if len(sys.argv) == 2:
175
90
    fn = sys.argv[1]
177
92
    s = f.read()
178
93
    f.close()
179
94
    f = file(fn, 'wb')
180
 
    f.write('%s')
 
95
    f.write('test message from fed\\n')
181
96
    f.write(s)
182
97
    f.close()
183
 
""" % (message, ))
 
98
""")
184
99
        f.close()
185
100
        if sys.platform == "win32":
186
101
            # [win32] make batch file and set BZR_EDITOR
196
111
            os.chmod('fed.py', 0755)
197
112
            os.environ['BZR_EDITOR'] = './fed.py'
198
113
 
199
 
    def test_edit_commit_message(self):
200
 
        working_tree = self.make_uncommitted_tree()
201
 
        self.make_fake_editor()
202
 
 
203
114
        mutter('edit_commit_message without infotext')
204
115
        self.assertEqual('test message from fed\n',
205
 
                         msgeditor.edit_commit_message(''))
206
 
 
207
 
        mutter('edit_commit_message with ascii string infotext')
208
 
        self.assertEqual('test message from fed\n',
209
 
                         msgeditor.edit_commit_message('spam'))
 
116
                         bzrlib.msgeditor.edit_commit_message(''))
210
117
 
211
118
        mutter('edit_commit_message with unicode infotext')
212
119
        self.assertEqual('test message from fed\n',
213
 
                         msgeditor.edit_commit_message(u'\u1234'))
214
 
 
215
 
        tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
216
 
        self.assertEqual('test message from fed\n', tmpl)
217
 
 
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('',
226
 
                                              start_message=''))
 
120
                         bzrlib.msgeditor.edit_commit_message(u'\u1234'))
227
121
 
228
122
    def test_deleted_commit_message(self):
229
123
        working_tree = self.make_uncommitted_tree()
233
127
        else:
234
128
            os.environ['BZR_EDITOR'] = 'rm'
235
129
 
236
 
        self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
 
130
        self.assertRaises((IOError, OSError), bzrlib.msgeditor.edit_commit_message, '')
237
131
 
238
132
    def test__get_editor(self):
239
133
        # Test that _get_editor can return a decent list of items
250
144
            f.write('editor = config_editor\n')
251
145
            f.close()
252
146
 
253
 
            editors = list(msgeditor._get_editor())
254
 
            editors = [editor for (editor, cfg_src) in editors]
 
147
            editors = list(bzrlib.msgeditor._get_editor())
255
148
 
256
149
            self.assertEqual(['bzr_editor', 'config_editor', 'visual',
257
150
                              'editor'], editors[:4])
276
169
                del os.environ['EDITOR']
277
170
            else:
278
171
                os.environ['EDITOR'] = editor
279
 
 
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')
285
 
        f.close()
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
289
 
        # editors.
290
 
        os.environ['EDITOR'] = self.make_do_nothing_editor()
291
 
        # Call _run_editor, capturing mutter.warning calls.
292
 
        warnings = []
293
 
        def warning(*args):
294
 
            warnings.append(args[0] % args[1:])
295
 
        _warning = trace.warning
296
 
        trace.warning = warning
297
 
        try:
298
 
            msgeditor._run_editor('')
299
 
        finally:
300
 
            trace.warning = _warning
301
 
        self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
302
 
 
303
 
    def test__create_temp_file_with_commit_template(self):
304
 
        # check that commit template written properly
305
 
        # and has platform native line-endings (CRLF on win32)
306
 
        create_file = msgeditor._create_temp_file_with_commit_template
307
 
        msgfilename, hasinfo = create_file('infotext','----','start message')
308
 
        self.assertNotEqual(None, msgfilename)
309
 
        self.assertTrue(hasinfo)
310
 
        expected = os.linesep.join(['start message',
311
 
                                    '',
312
 
                                    '',
313
 
                                    '----',
314
 
                                    '',
315
 
                                    'infotext'])
316
 
        self.assertFileEqual(expected, msgfilename)
317
 
 
318
 
    def test__create_temp_file_with_commit_template_in_unicode_dir(self):
319
 
        self.requireFeature(tests.UnicodeFilenameFeature)
320
 
        if hasattr(self, 'info'):
321
 
            os.mkdir(self.info['directory'])
322
 
            os.chdir(self.info['directory'])
323
 
            msgeditor._create_temp_file_with_commit_template('infotext')
324
 
        else:
325
 
            raise TestNotApplicable('Test run elsewhere with non-ascii data.')
326
 
 
327
 
    def test__create_temp_file_with_empty_commit_template(self):
328
 
        # empty file
329
 
        create_file = msgeditor._create_temp_file_with_commit_template
330
 
        msgfilename, hasinfo = create_file('')
331
 
        self.assertNotEqual(None, msgfilename)
332
 
        self.assertFalse(hasinfo)
333
 
        self.assertFileEqual('', msgfilename)
334
 
 
335
 
    def test_unsupported_encoding_commit_message(self):
336
 
        old_env = osutils.set_or_unset_env('LANG', 'C')
337
 
        try:
338
 
            # LANG env variable has no effect on Windows
339
 
            # but some characters anyway cannot be represented
340
 
            # in default user encoding
341
 
            char = probe_bad_non_ascii(osutils.get_user_encoding())
342
 
            if char is None:
343
 
                raise TestSkipped('Cannot find suitable non-ascii character '
344
 
                    'for user_encoding (%s)' % osutils.get_user_encoding())
345
 
 
346
 
            self.make_fake_editor(message=char)
347
 
 
348
 
            working_tree = self.make_uncommitted_tree()
349
 
            self.assertRaises(errors.BadCommitMessageEncoding,
350
 
                              msgeditor.edit_commit_message, '')
351
 
        finally:
352
 
            osutils.set_or_unset_env('LANG', old_env)
353
 
 
354
 
    def test_generate_commit_message_template_no_hooks(self):
355
 
        commit_obj = commit.Commit()
356
 
        self.assertIs(None,
357
 
            msgeditor.generate_commit_message_template(commit_obj))
358
 
 
359
 
    def test_generate_commit_message_template_hook(self):
360
 
        def restoreDefaults():
361
 
            msgeditor.hooks['commit_message_template'] = []
362
 
        self.addCleanup(restoreDefaults)
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))