← 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: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

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 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Test commit message editor.
18
18
"""
20
20
import os
21
21
import sys
22
22
 
23
 
from bzrlib import (
24
 
    commit,
25
 
    config,
26
 
    errors,
27
 
    msgeditor,
28
 
    osutils,
29
 
    tests,
30
 
    trace,
31
 
    )
32
23
from bzrlib.branch import Branch
33
24
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
 
25
import bzrlib.msgeditor 
 
26
from bzrlib.tests import TestCaseWithTransport, TestSkipped
48
27
from bzrlib.trace import mutter
49
28
 
50
29
 
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
30
class MsgEditorTest(TestCaseWithTransport):
59
31
 
60
32
    def make_uncommitted_tree(self):
69
41
                "filesystem encoding %s" % sys.getfilesystemencoding())
70
42
        working_tree.add(filename)
71
43
        return working_tree
72
 
 
 
44
    
73
45
    def test_commit_template(self):
74
46
        """Test building a commit message template"""
75
47
        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):
 
48
        template = bzrlib.msgeditor.make_commit_message_template(working_tree, None)
 
49
        self.assertEqualDiff(template,
 
50
u"""\
 
51
added:
 
52
  hell\u00d8
 
53
""")
 
54
 
 
55
    def setUp(self):
 
56
        super(MsgEditorTest, self).setUp()
 
57
        self._bzr_editor = os.environ.get('BZR_EDITOR', None)
 
58
 
 
59
    def tearDown(self):
 
60
        if self._bzr_editor is not None:
 
61
            os.environ['BZR_EDITOR'] = self._bzr_editor
 
62
        else:
 
63
            if os.environ.get('BZR_EDITOR', None) is not None:
 
64
                del os.environ['BZR_EDITOR']
 
65
        super(MsgEditorTest, self).tearDown()
 
66
 
 
67
    def test_run_editor(self):
147
68
        if sys.platform == "win32":
148
69
            f = file('fed.bat', 'w')
149
70
            f.write('@rem dummy fed')
150
71
            f.close()
151
 
            return 'fed.bat'
 
72
            os.environ['BZR_EDITOR'] = 'fed.bat'
152
73
        else:
153
74
            f = file('fed.sh', 'wb')
154
75
            f.write('#!/bin/sh\n')
155
76
            f.close()
156
77
            os.chmod('fed.sh', 0755)
157
 
            return './fed.sh'
 
78
            os.environ['BZR_EDITOR'] = './fed.sh'
158
79
 
159
 
    def test_run_editor(self):
160
 
        os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
161
 
        self.assertEqual(True, msgeditor._run_editor(''),
 
80
        self.assertEqual(True, bzrlib.msgeditor._run_editor(''),
162
81
                         'Unable to run dummy fake editor')
163
82
 
164
 
    def make_fake_editor(self, message='test message from fed\\n'):
 
83
    def make_fake_editor(self):
165
84
        """Set up environment so that an editor will be a known script.
166
85
 
167
86
        Sets up BZR_EDITOR so that if an editor is spawned it will run a
170
89
        f = file('fed.py', 'wb')
171
90
        f.write('#!%s\n' % sys.executable)
172
91
        f.write("""\
173
 
# coding=utf-8
174
92
import sys
175
93
if len(sys.argv) == 2:
176
94
    fn = sys.argv[1]
178
96
    s = f.read()
179
97
    f.close()
180
98
    f = file(fn, 'wb')
181
 
    f.write('%s')
 
99
    f.write('test message from fed\\n')
182
100
    f.write(s)
183
101
    f.close()
184
 
""" % (message, ))
 
102
""")
185
103
        f.close()
186
104
        if sys.platform == "win32":
187
105
            # [win32] make batch file and set BZR_EDITOR
203
121
 
204
122
        mutter('edit_commit_message without infotext')
205
123
        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'))
 
124
                         bzrlib.msgeditor.edit_commit_message(''))
211
125
 
212
126
        mutter('edit_commit_message with unicode infotext')
213
127
        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)
 
128
                         bzrlib.msgeditor.edit_commit_message(u'\u1234'))
218
129
 
219
130
    def test_start_message(self):
220
131
        self.make_uncommitted_tree()
221
132
        self.make_fake_editor()
222
133
        self.assertEqual('test message from fed\nstart message\n',
223
 
                         msgeditor.edit_commit_message('',
 
134
                         bzrlib.msgeditor.edit_commit_message('',
224
135
                                              start_message='start message\n'))
225
136
        self.assertEqual('test message from fed\n',
226
 
                         msgeditor.edit_commit_message('',
 
137
                         bzrlib.msgeditor.edit_commit_message('',
227
138
                                              start_message=''))
228
139
 
229
140
    def test_deleted_commit_message(self):
234
145
        else:
235
146
            os.environ['BZR_EDITOR'] = 'rm'
236
147
 
237
 
        self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
 
148
        self.assertRaises((IOError, OSError), bzrlib.msgeditor.edit_commit_message, '')
238
149
 
239
150
    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
 
151
        # Test that _get_editor can return a decent list of items
 
152
        bzr_editor = os.environ.get('BZR_EDITOR')
 
153
        visual = os.environ.get('VISUAL')
 
154
        editor = os.environ.get('EDITOR')
280
155
        try:
281
 
            msgeditor._run_editor('')
 
156
            os.environ['BZR_EDITOR'] = 'bzr_editor'
 
157
            os.environ['VISUAL'] = 'visual'
 
158
            os.environ['EDITOR'] = 'editor'
 
159
 
 
160
            ensure_config_dir_exists()
 
161
            f = open(config_filename(), 'wb')
 
162
            f.write('editor = config_editor\n')
 
163
            f.close()
 
164
 
 
165
            editors = list(bzrlib.msgeditor._get_editor())
 
166
 
 
167
            self.assertEqual(['bzr_editor', 'config_editor', 'visual',
 
168
                              'editor'], editors[:4])
 
169
 
 
170
            if sys.platform == 'win32':
 
171
                self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
 
172
            else:
 
173
                self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano',
 
174
                                  'joe'], editors[4:])
 
175
 
282
176
        finally:
283
 
            trace.warning = _warning
284
 
        self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
 
177
            # Restore the environment
 
178
            if bzr_editor is None:
 
179
                del os.environ['BZR_EDITOR']
 
180
            else:
 
181
                os.environ['BZR_EDITOR'] = bzr_editor
 
182
            if visual is None:
 
183
                del os.environ['VISUAL']
 
184
            else:
 
185
                os.environ['VISUAL'] = visual
 
186
            if editor is None:
 
187
                del os.environ['EDITOR']
 
188
            else:
 
189
                os.environ['EDITOR'] = editor
285
190
 
286
191
    def test__create_temp_file_with_commit_template(self):
287
192
        # check that commit template written properly
288
193
        # and has platform native line-endings (CRLF on win32)
289
 
        create_file = msgeditor._create_temp_file_with_commit_template
 
194
        create_file = bzrlib.msgeditor._create_temp_file_with_commit_template
290
195
        msgfilename, hasinfo = create_file('infotext','----','start message')
291
196
        self.assertNotEqual(None, msgfilename)
292
197
        self.assertTrue(hasinfo)
298
203
                                    'infotext'])
299
204
        self.assertFileEqual(expected, msgfilename)
300
205
 
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
206
    def test__create_temp_file_with_empty_commit_template(self):
311
207
        # empty file
312
 
        create_file = msgeditor._create_temp_file_with_commit_template
 
208
        create_file = bzrlib.msgeditor._create_temp_file_with_commit_template
313
209
        msgfilename, hasinfo = create_file('')
314
210
        self.assertNotEqual(None, msgfilename)
315
211
        self.assertFalse(hasinfo)
316
212
        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)