← 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: Canonical.com Patch Queue Manager
  • Date: 2006-07-12 12:36:57 UTC
  • mfrom: (1732.3.4 bzr.revnoX)
  • Revision ID: pqm@pqm.ubuntu.com-20060712123657-365eeb32b69308bf
(matthieu) revno:x:url revision spec

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_msgeditor.py
1
 
# Copyright (C) 2005-2010 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
 
    config,
26
 
    errors,
27
 
    msgeditor,
28
 
    osutils,
29
 
    tests,
30
 
    trace,
31
 
    )
32
22
from bzrlib.branch import Branch
33
23
from bzrlib.config import ensure_config_dir_exists, config_filename
34
 
from bzrlib.msgeditor import (
35
 
    make_commit_message_template_encoded,
36
 
    edit_commit_message_encoded
37
 
)
38
 
from bzrlib.tests import (
39
 
    TestCaseInTempDir,
40
 
    TestCaseWithTransport,
41
 
    TestNotApplicable,
42
 
    TestSkipped,
43
 
    multiply_tests,
44
 
    probe_bad_non_ascii,
45
 
    split_suite_by_re,
46
 
    )
47
 
from bzrlib.tests.EncodingAdapter import encoding_scenarios
 
24
import bzrlib.msgeditor 
 
25
from bzrlib.tests import TestCaseWithTransport, TestSkipped
48
26
from bzrlib.trace import mutter
49
27
 
50
28
 
51
 
def load_tests(standard_tests, module, loader):
52
 
    """Parameterize the test for tempfile creation with different encodings."""
53
 
    to_adapt, result = split_suite_by_re(standard_tests,
54
 
        "test__create_temp_file_with_commit_template_in_unicode_dir")
55
 
    return multiply_tests(to_adapt, encoding_scenarios, result)
56
 
 
57
 
 
58
29
class MsgEditorTest(TestCaseWithTransport):
59
30
 
60
31
    def make_uncommitted_tree(self):
69
40
                "filesystem encoding %s" % sys.getfilesystemencoding())
70
41
        working_tree.add(filename)
71
42
        return working_tree
72
 
 
 
43
    
73
44
    def test_commit_template(self):
74
45
        """Test building a commit message template"""
75
46
        working_tree = self.make_uncommitted_tree()
76
 
        template = msgeditor.make_commit_message_template(working_tree,
77
 
                                                                 None)
78
 
        self.assertEqualDiff(template,
79
 
u"""\
80
 
added:
81
 
  hell\u00d8
82
 
""")
83
 
 
84
 
    def make_multiple_pending_tree(self):
85
 
        from bzrlib import config
86
 
        config.GlobalConfig().set_user_option('email',
87
 
                                              'Bilbo Baggins <bb@hobbit.net>')
88
 
        tree = self.make_branch_and_tree('a')
89
 
        tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
90
 
        tree2 = tree.bzrdir.clone('b').open_workingtree()
91
 
        tree.commit('Minor tweak.', timestamp=1231977840, timezone=0)
92
 
        tree2.commit('Feature X work.', timestamp=1233186240, timezone=0)
93
 
        tree3 = tree2.bzrdir.clone('c').open_workingtree()
94
 
        tree2.commit('Feature X finished.', timestamp=1233187680, timezone=0)
95
 
        tree3.commit('Feature Y, based on initial X work.',
96
 
                     timestamp=1233285960, timezone=0)
97
 
        tree.merge_from_branch(tree2.branch)
98
 
        tree.merge_from_branch(tree3.branch, force=True)
99
 
        return tree
100
 
 
101
 
    def test_commit_template_pending_merges(self):
102
 
        """Test building a commit message template when there are pending
103
 
        merges.  The commit message should show all pending merge revisions,
104
 
        as does 'status -v', not only the merge tips.
105
 
        """
106
 
        working_tree = self.make_multiple_pending_tree()
107
 
        template = msgeditor.make_commit_message_template(working_tree, None)
108
 
        self.assertEqualDiff(template,
109
 
u"""\
110
 
pending merges:
111
 
  Bilbo Baggins 2009-01-29 Feature X finished.
112
 
    Bilbo Baggins 2009-01-28 Feature X work.
113
 
  Bilbo Baggins 2009-01-30 Feature Y, based on initial X work.
114
 
""")
115
 
 
116
 
    def test_commit_template_encoded(self):
117
 
        """Test building a commit message template"""
118
 
        working_tree = self.make_uncommitted_tree()
119
 
        template = make_commit_message_template_encoded(working_tree,
120
 
                                                        None,
121
 
                                                        output_encoding='utf8')
122
 
        self.assertEqualDiff(template,
123
 
u"""\
124
 
added:
125
 
  hell\u00d8
126
 
""".encode("utf8"))
127
 
 
128
 
 
129
 
    def test_commit_template_and_diff(self):
130
 
        """Test building a commit message template"""
131
 
        working_tree = self.make_uncommitted_tree()
132
 
        template = make_commit_message_template_encoded(working_tree,
133
 
                                                        None,
134
 
                                                        diff=True,
135
 
                                                        output_encoding='utf8')
136
 
 
137
 
        self.assertTrue("""\
138
 
@@ -0,0 +1,1 @@
139
 
+contents of hello
140
 
""" in template)
141
 
        self.assertTrue(u"""\
142
 
added:
143
 
  hell\u00d8
144
 
""".encode('utf8') in template)
145
 
 
146
 
    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):
147
67
        if sys.platform == "win32":
148
68
            f = file('fed.bat', 'w')
149
69
            f.write('@rem dummy fed')
150
70
            f.close()
151
 
            return 'fed.bat'
 
71
            os.environ['BZR_EDITOR'] = 'fed.bat'
152
72
        else:
153
73
            f = file('fed.sh', 'wb')
154
74
            f.write('#!/bin/sh\n')
155
75
            f.close()
156
76
            os.chmod('fed.sh', 0755)
157
 
            return './fed.sh'
 
77
            os.environ['BZR_EDITOR'] = './fed.sh'
158
78
 
159
 
    def test_run_editor(self):
160
 
        os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
161
 
        self.assertEqual(True, msgeditor._run_editor(''),
 
79
        self.assertEqual(True, bzrlib.msgeditor._run_editor(''),
162
80
                         'Unable to run dummy fake editor')
163
81
 
164
 
    def make_fake_editor(self, message='test message from fed\\n'):
165
 
        """Set up environment so that an editor will be a known script.
166
 
 
167
 
        Sets up BZR_EDITOR so that if an editor is spawned it will run a
168
 
        script that just adds a known message to the start of the file.
169
 
        """
 
82
    def test_edit_commit_message(self):
 
83
        working_tree = self.make_uncommitted_tree()
 
84
        # make fake editor
170
85
        f = file('fed.py', 'wb')
171
86
        f.write('#!%s\n' % sys.executable)
172
87
        f.write("""\
173
 
# coding=utf-8
174
88
import sys
175
89
if len(sys.argv) == 2:
176
90
    fn = sys.argv[1]
178
92
    s = f.read()
179
93
    f.close()
180
94
    f = file(fn, 'wb')
181
 
    f.write('%s')
 
95
    f.write('test message from fed\\n')
182
96
    f.write(s)
183
97
    f.close()
184
 
""" % (message, ))
 
98
""")
185
99
        f.close()
186
100
        if sys.platform == "win32":
187
101
            # [win32] make batch file and set BZR_EDITOR
197
111
            os.chmod('fed.py', 0755)
198
112
            os.environ['BZR_EDITOR'] = './fed.py'
199
113
 
200
 
    def test_edit_commit_message(self):
201
 
        working_tree = self.make_uncommitted_tree()
202
 
        self.make_fake_editor()
203
 
 
204
114
        mutter('edit_commit_message without infotext')
205
115
        self.assertEqual('test message from fed\n',
206
 
                         msgeditor.edit_commit_message(''))
207
 
 
208
 
        mutter('edit_commit_message with ascii string infotext')
209
 
        self.assertEqual('test message from fed\n',
210
 
                         msgeditor.edit_commit_message('spam'))
 
116
                         bzrlib.msgeditor.edit_commit_message(''))
211
117
 
212
118
        mutter('edit_commit_message with unicode infotext')
213
119
        self.assertEqual('test message from fed\n',
214
 
                         msgeditor.edit_commit_message(u'\u1234'))
215
 
 
216
 
        tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
217
 
        self.assertEqual('test message from fed\n', tmpl)
218
 
 
219
 
    def test_start_message(self):
220
 
        self.make_uncommitted_tree()
221
 
        self.make_fake_editor()
222
 
        self.assertEqual('test message from fed\nstart message\n',
223
 
                         msgeditor.edit_commit_message('',
224
 
                                              start_message='start message\n'))
225
 
        self.assertEqual('test message from fed\n',
226
 
                         msgeditor.edit_commit_message('',
227
 
                                              start_message=''))
 
120
                         bzrlib.msgeditor.edit_commit_message(u'\u1234'))
228
121
 
229
122
    def test_deleted_commit_message(self):
230
123
        working_tree = self.make_uncommitted_tree()
234
127
        else:
235
128
            os.environ['BZR_EDITOR'] = 'rm'
236
129
 
237
 
        self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
 
130
        self.assertRaises((IOError, OSError), bzrlib.msgeditor.edit_commit_message, '')
238
131
 
239
132
    def test__get_editor(self):
240
 
        os.environ['BZR_EDITOR'] = 'bzr_editor'
241
 
        os.environ['VISUAL'] = 'visual'
242
 
        os.environ['EDITOR'] = 'editor'
243
 
 
244
 
        conf = config.GlobalConfig.from_string('editor = config_editor\n',
245
 
                                               save=True)
246
 
 
247
 
        editors = list(msgeditor._get_editor())
248
 
        editors = [editor for (editor, cfg_src) in editors]
249
 
 
250
 
        self.assertEqual(['bzr_editor', 'config_editor', 'visual', 'editor'],
251
 
                         editors[:4])
252
 
 
253
 
        if sys.platform == 'win32':
254
 
            self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
255
 
        else:
256
 
            self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe'],
257
 
                             editors[4:])
258
 
 
259
 
 
260
 
    def test__run_editor_EACCES(self):
261
 
        """If running a configured editor raises EACESS, the user is warned."""
262
 
        os.environ['BZR_EDITOR'] = 'eacces.py'
263
 
        f = file('eacces.py', 'wb')
264
 
        f.write('# Not a real editor')
265
 
        f.close()
266
 
        # Make the fake editor unreadable (and unexecutable)
267
 
        os.chmod('eacces.py', 0)
268
 
        # Set $EDITOR so that _run_editor will terminate before trying real
269
 
        # editors.
270
 
        os.environ['EDITOR'] = self.make_do_nothing_editor()
271
 
        # Call _run_editor, capturing mutter.warning calls.
272
 
        warnings = []
273
 
        def warning(*args):
274
 
            if len(args) > 1:
275
 
                warnings.append(args[0] % args[1:])
276
 
            else:
277
 
                warnings.append(args[0])
278
 
        _warning = trace.warning
279
 
        trace.warning = warning
280
 
        try:
281
 
            msgeditor._run_editor('')
282
 
        finally:
283
 
            trace.warning = _warning
284
 
        self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
285
 
 
286
 
    def test__create_temp_file_with_commit_template(self):
287
 
        # check that commit template written properly
288
 
        # and has platform native line-endings (CRLF on win32)
289
 
        create_file = msgeditor._create_temp_file_with_commit_template
290
 
        msgfilename, hasinfo = create_file('infotext','----','start message')
291
 
        self.assertNotEqual(None, msgfilename)
292
 
        self.assertTrue(hasinfo)
293
 
        expected = os.linesep.join(['start message',
294
 
                                    '',
295
 
                                    '',
296
 
                                    '----',
297
 
                                    '',
298
 
                                    'infotext'])
299
 
        self.assertFileEqual(expected, msgfilename)
300
 
 
301
 
    def test__create_temp_file_with_commit_template_in_unicode_dir(self):
302
 
        self.requireFeature(tests.UnicodeFilenameFeature)
303
 
        if hasattr(self, 'info'):
304
 
            os.mkdir(self.info['directory'])
305
 
            os.chdir(self.info['directory'])
306
 
            msgeditor._create_temp_file_with_commit_template('infotext')
307
 
        else:
308
 
            raise TestNotApplicable('Test run elsewhere with non-ascii data.')
309
 
 
310
 
    def test__create_temp_file_with_empty_commit_template(self):
311
 
        # empty file
312
 
        create_file = msgeditor._create_temp_file_with_commit_template
313
 
        msgfilename, hasinfo = create_file('')
314
 
        self.assertNotEqual(None, msgfilename)
315
 
        self.assertFalse(hasinfo)
316
 
        self.assertFileEqual('', msgfilename)
317
 
 
318
 
    def test_unsupported_encoding_commit_message(self):
319
 
        old_env = osutils.set_or_unset_env('LANG', 'C')
320
 
        try:
321
 
            # LANG env variable has no effect on Windows
322
 
            # but some characters anyway cannot be represented
323
 
            # in default user encoding
324
 
            char = probe_bad_non_ascii(osutils.get_user_encoding())
325
 
            if char is None:
326
 
                raise TestSkipped('Cannot find suitable non-ascii character '
327
 
                    'for user_encoding (%s)' % osutils.get_user_encoding())
328
 
 
329
 
            self.make_fake_editor(message=char)
330
 
 
331
 
            working_tree = self.make_uncommitted_tree()
332
 
            self.assertRaises(errors.BadCommitMessageEncoding,
333
 
                              msgeditor.edit_commit_message, '')
334
 
        finally:
335
 
            osutils.set_or_unset_env('LANG', old_env)
336
 
 
337
 
    def test_generate_commit_message_template_no_hooks(self):
338
 
        commit_obj = commit.Commit()
339
 
        self.assertIs(None,
340
 
            msgeditor.generate_commit_message_template(commit_obj))
341
 
 
342
 
    def test_generate_commit_message_template_hook(self):
343
 
        msgeditor.hooks.install_named_hook("commit_message_template",
344
 
                lambda commit_obj, msg: "save me some typing\n", None)
345
 
        commit_obj = commit.Commit()
346
 
        self.assertEquals("save me some typing\n",
347
 
            msgeditor.generate_commit_message_template(commit_obj))
348
 
 
349
 
 
350
 
# GZ 2009-11-17: This wants moving to osutils when the errno checking code is
351
 
class TestPlatformErrnoWorkarounds(TestCaseInTempDir):
352
 
    """Ensuring workarounds enshrined in code actually serve a purpose"""
353
 
 
354
 
    def test_subprocess_call_bad_file(self):
355
 
        if sys.platform != "win32":
356
 
            raise TestNotApplicable("Workarounds for windows only")
357
 
        import subprocess, errno
358
 
        ERROR_BAD_EXE_FORMAT = 193
359
 
        file("textfile.txt", "w").close()
360
 
        e = self.assertRaises(WindowsError, subprocess.call, "textfile.txt")
361
 
        # Python2.4 used the 'winerror' as the errno, which confuses a lot of
362
 
        # our error trapping code. Make sure that we understand the mapping
363
 
        # correctly.
364
 
        if sys.version_info >= (2, 5):
365
 
            self.assertEqual(e.errno, errno.ENOEXEC)
366
 
            self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)
367
 
        else:
368
 
            self.assertEqual(e.errno, ERROR_BAD_EXE_FORMAT)
 
133
        # Test that _get_editor can return a decent list of items
 
134
        bzr_editor = os.environ.get('BZR_EDITOR')
 
135
        visual = os.environ.get('VISUAL')
 
136
        editor = os.environ.get('EDITOR')
 
137
        try:
 
138
            os.environ['BZR_EDITOR'] = 'bzr_editor'
 
139
            os.environ['VISUAL'] = 'visual'
 
140
            os.environ['EDITOR'] = 'editor'
 
141
 
 
142
            ensure_config_dir_exists()
 
143
            f = open(config_filename(), 'wb')
 
144
            f.write('editor = config_editor\n')
 
145
            f.close()
 
146
 
 
147
            editors = list(bzrlib.msgeditor._get_editor())
 
148
 
 
149
            self.assertEqual(['bzr_editor', 'config_editor', 'visual',
 
150
                              'editor'], editors[:4])
 
151
 
 
152
            if sys.platform == 'win32':
 
153
                self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
 
154
            else:
 
155
                self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano',
 
156
                                  'joe'], editors[4:])
 
157
 
 
158
        finally:
 
159
            # Restore the environment
 
160
            if bzr_editor is None:
 
161
                del os.environ['BZR_EDITOR']
 
162
            else:
 
163
                os.environ['BZR_EDITOR'] = bzr_editor
 
164
            if visual is None:
 
165
                del os.environ['VISUAL']
 
166
            else:
 
167
                os.environ['VISUAL'] = visual
 
168
            if editor is None:
 
169
                del os.environ['EDITOR']
 
170
            else:
 
171
                os.environ['EDITOR'] = editor