← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_msgeditor.py

(vila) Fix test failures blocking package builds. (Vincent Ladeuil)

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-2011 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Test commit message editor.
18
18
"""
20
20
import os
21
21
import sys
22
22
 
23
 
import bzrlib
24
23
from bzrlib import (
 
24
    commit,
 
25
    config,
25
26
    errors,
26
27
    msgeditor,
27
28
    osutils,
28
 
    tests,
 
29
    trace,
29
30
    )
30
 
from bzrlib.branch import Branch
31
 
from bzrlib.config import ensure_config_dir_exists, config_filename
32
31
from bzrlib.msgeditor import (
33
32
    make_commit_message_template_encoded,
34
33
    edit_commit_message_encoded
35
34
)
36
35
from bzrlib.tests import (
37
 
    iter_suite_tests,
38
 
    probe_bad_non_ascii,
39
 
    split_suite_by_re,
 
36
    features,
 
37
    TestCaseInTempDir,
40
38
    TestCaseWithTransport,
41
39
    TestNotApplicable,
42
40
    TestSkipped,
 
41
    multiply_tests,
 
42
    probe_bad_non_ascii,
 
43
    split_suite_by_re,
43
44
    )
44
 
from bzrlib.tests.EncodingAdapter import EncodingTestAdapter
 
45
from bzrlib.tests.EncodingAdapter import encoding_scenarios
45
46
from bzrlib.trace import mutter
46
47
 
47
48
 
49
50
    """Parameterize the test for tempfile creation with different encodings."""
50
51
    to_adapt, result = split_suite_by_re(standard_tests,
51
52
        "test__create_temp_file_with_commit_template_in_unicode_dir")
52
 
    for test in iter_suite_tests(to_adapt):
53
 
        result.addTests(EncodingTestAdapter().adapt(test))
54
 
    return result
 
53
    return multiply_tests(to_adapt, encoding_scenarios, result)
55
54
 
56
55
 
57
56
class MsgEditorTest(TestCaseWithTransport):
68
67
                "filesystem encoding %s" % sys.getfilesystemencoding())
69
68
        working_tree.add(filename)
70
69
        return working_tree
71
 
    
 
70
 
72
71
    def test_commit_template(self):
73
72
        """Test building a commit message template"""
74
73
        working_tree = self.make_uncommitted_tree()
80
79
  hell\u00d8
81
80
""")
82
81
 
 
82
    def make_multiple_pending_tree(self):
 
83
        config.GlobalStack().set('email', 'Bilbo Baggins <bb@hobbit.net>')
 
84
        tree = self.make_branch_and_tree('a')
 
85
        tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
 
86
        tree2 = tree.bzrdir.clone('b').open_workingtree()
 
87
        tree.commit('Minor tweak.', timestamp=1231977840, timezone=0)
 
88
        tree2.commit('Feature X work.', timestamp=1233186240, timezone=0)
 
89
        tree3 = tree2.bzrdir.clone('c').open_workingtree()
 
90
        tree2.commit('Feature X finished.', timestamp=1233187680, timezone=0)
 
91
        tree3.commit('Feature Y, based on initial X work.',
 
92
                     timestamp=1233285960, timezone=0)
 
93
        tree.merge_from_branch(tree2.branch)
 
94
        tree.merge_from_branch(tree3.branch, force=True)
 
95
        return tree
 
96
 
 
97
    def test_commit_template_pending_merges(self):
 
98
        """Test building a commit message template when there are pending
 
99
        merges.  The commit message should show all pending merge revisions,
 
100
        as does 'status -v', not only the merge tips.
 
101
        """
 
102
        working_tree = self.make_multiple_pending_tree()
 
103
        template = msgeditor.make_commit_message_template(working_tree, None)
 
104
        self.assertEqualDiff(template,
 
105
u"""\
 
106
pending merges:
 
107
  Bilbo Baggins 2009-01-29 Feature X finished.
 
108
    Bilbo Baggins 2009-01-28 Feature X work.
 
109
  Bilbo Baggins 2009-01-30 Feature Y, based on initial X work.
 
110
""")
 
111
 
83
112
    def test_commit_template_encoded(self):
84
113
        """Test building a commit message template"""
85
114
        working_tree = self.make_uncommitted_tree()
110
139
  hell\u00d8
111
140
""".encode('utf8') in template)
112
141
 
113
 
    def test_run_editor(self):
 
142
    def make_do_nothing_editor(self, basename='fed'):
114
143
        if sys.platform == "win32":
115
 
            f = file('fed.bat', 'w')
 
144
            name = basename + '.bat'
 
145
            f = file(name, 'w')
116
146
            f.write('@rem dummy fed')
117
147
            f.close()
118
 
            os.environ['BZR_EDITOR'] = 'fed.bat'
 
148
            return name
119
149
        else:
120
 
            f = file('fed.sh', 'wb')
 
150
            name = basename + '.sh'
 
151
            f = file(name, 'wb')
121
152
            f.write('#!/bin/sh\n')
122
153
            f.close()
123
 
            os.chmod('fed.sh', 0755)
124
 
            os.environ['BZR_EDITOR'] = './fed.sh'
 
154
            os.chmod(name, 0755)
 
155
            return './' + name
125
156
 
 
157
    def test_run_editor(self):
 
158
        self.overrideEnv('BZR_EDITOR', self.make_do_nothing_editor())
126
159
        self.assertEqual(True, msgeditor._run_editor(''),
127
160
                         'Unable to run dummy fake editor')
128
161
 
 
162
    def test_parse_editor_name(self):
 
163
        """Correctly interpret names with spaces.
 
164
 
 
165
        See <https://bugs.launchpad.net/bzr/+bug/220331>
 
166
        """
 
167
        self.overrideEnv('BZR_EDITOR',
 
168
            '"%s"' % self.make_do_nothing_editor('name with spaces'))
 
169
        self.assertEqual(True, msgeditor._run_editor('a_filename'))    
 
170
 
129
171
    def make_fake_editor(self, message='test message from fed\\n'):
130
172
        """Set up environment so that an editor will be a known script.
131
173
 
156
198
"%s" fed.py %%1
157
199
""" % sys.executable)
158
200
            f.close()
159
 
            os.environ['BZR_EDITOR'] = 'fed.bat'
 
201
            self.overrideEnv('BZR_EDITOR', 'fed.bat')
160
202
        else:
161
203
            # [non-win32] make python script executable and set BZR_EDITOR
162
204
            os.chmod('fed.py', 0755)
163
 
            os.environ['BZR_EDITOR'] = './fed.py'
 
205
            self.overrideEnv('BZR_EDITOR', './fed.py')
164
206
 
165
207
    def test_edit_commit_message(self):
166
208
        working_tree = self.make_uncommitted_tree()
195
237
        working_tree = self.make_uncommitted_tree()
196
238
 
197
239
        if sys.platform == 'win32':
198
 
            os.environ['BZR_EDITOR'] = 'cmd.exe /c del'
 
240
            editor = 'cmd.exe /c del'
199
241
        else:
200
 
            os.environ['BZR_EDITOR'] = 'rm'
 
242
            editor = 'rm'
 
243
        self.overrideEnv('BZR_EDITOR', editor)
201
244
 
202
245
        self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
203
246
 
204
247
    def test__get_editor(self):
205
 
        # Test that _get_editor can return a decent list of items
206
 
        bzr_editor = os.environ.get('BZR_EDITOR')
207
 
        visual = os.environ.get('VISUAL')
208
 
        editor = os.environ.get('EDITOR')
 
248
        self.overrideEnv('BZR_EDITOR', 'bzr_editor')
 
249
        self.overrideEnv('VISUAL', 'visual')
 
250
        self.overrideEnv('EDITOR', 'editor')
 
251
 
 
252
        conf = config.GlobalStack()
 
253
        conf.store._load_from_string('[DEFAULT]\neditor = config_editor\n')
 
254
        conf.store.save()
 
255
        editors = list(msgeditor._get_editor())
 
256
        editors = [editor for (editor, cfg_src) in editors]
 
257
 
 
258
        self.assertEqual(['bzr_editor', 'config_editor', 'visual', 'editor'],
 
259
                         editors[:4])
 
260
 
 
261
        if sys.platform == 'win32':
 
262
            self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
 
263
        else:
 
264
            self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe'],
 
265
                             editors[4:])
 
266
 
 
267
 
 
268
    def test__run_editor_EACCES(self):
 
269
        """If running a configured editor raises EACESS, the user is warned."""
 
270
        self.overrideEnv('BZR_EDITOR', 'eacces.py')
 
271
        f = file('eacces.py', 'wb')
 
272
        f.write('# Not a real editor')
 
273
        f.close()
 
274
        # Make the fake editor unreadable (and unexecutable)
 
275
        os.chmod('eacces.py', 0)
 
276
        # Set $EDITOR so that _run_editor will terminate before trying real
 
277
        # editors.
 
278
        self.overrideEnv('EDITOR', self.make_do_nothing_editor())
 
279
        # Call _run_editor, capturing mutter.warning calls.
 
280
        warnings = []
 
281
        def warning(*args):
 
282
            if len(args) > 1:
 
283
                warnings.append(args[0] % args[1:])
 
284
            else:
 
285
                warnings.append(args[0])
 
286
        _warning = trace.warning
 
287
        trace.warning = warning
209
288
        try:
210
 
            os.environ['BZR_EDITOR'] = 'bzr_editor'
211
 
            os.environ['VISUAL'] = 'visual'
212
 
            os.environ['EDITOR'] = 'editor'
213
 
 
214
 
            ensure_config_dir_exists()
215
 
            f = open(config_filename(), 'wb')
216
 
            f.write('editor = config_editor\n')
217
 
            f.close()
218
 
 
219
 
            editors = list(msgeditor._get_editor())
220
 
 
221
 
            self.assertEqual(['bzr_editor', 'config_editor', 'visual',
222
 
                              'editor'], editors[:4])
223
 
 
224
 
            if sys.platform == 'win32':
225
 
                self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
226
 
            else:
227
 
                self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano',
228
 
                                  'joe'], editors[4:])
229
 
 
 
289
            msgeditor._run_editor('')
230
290
        finally:
231
 
            # Restore the environment
232
 
            if bzr_editor is None:
233
 
                del os.environ['BZR_EDITOR']
234
 
            else:
235
 
                os.environ['BZR_EDITOR'] = bzr_editor
236
 
            if visual is None:
237
 
                del os.environ['VISUAL']
238
 
            else:
239
 
                os.environ['VISUAL'] = visual
240
 
            if editor is None:
241
 
                del os.environ['EDITOR']
242
 
            else:
243
 
                os.environ['EDITOR'] = editor
 
291
            trace.warning = _warning
 
292
        self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
244
293
 
245
294
    def test__create_temp_file_with_commit_template(self):
246
295
        # check that commit template written properly
258
307
        self.assertFileEqual(expected, msgfilename)
259
308
 
260
309
    def test__create_temp_file_with_commit_template_in_unicode_dir(self):
261
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
310
        self.requireFeature(features.UnicodeFilenameFeature)
262
311
        if hasattr(self, 'info'):
263
 
            os.mkdir(self.info['directory'])
264
 
            os.chdir(self.info['directory'])
265
 
            msgeditor._create_temp_file_with_commit_template('infotext')
 
312
            tmpdir = self.info['directory']
 
313
            os.mkdir(tmpdir)
 
314
            # Force the creation of temp file in a directory whose name
 
315
            # requires some encoding support
 
316
            msgeditor._create_temp_file_with_commit_template('infotext',
 
317
                                                             tmpdir=tmpdir)
266
318
        else:
267
319
            raise TestNotApplicable('Test run elsewhere with non-ascii data.')
268
320
 
275
327
        self.assertFileEqual('', msgfilename)
276
328
 
277
329
    def test_unsupported_encoding_commit_message(self):
278
 
        old_env = osutils.set_or_unset_env('LANG', 'C')
279
 
        try:
280
 
            # LANG env variable has no effect on Windows
281
 
            # but some characters anyway cannot be represented
282
 
            # in default user encoding
283
 
            char = probe_bad_non_ascii(bzrlib.user_encoding)
284
 
            if char is None:
285
 
                raise TestSkipped('Cannot find suitable non-ascii character '
286
 
                    'for user_encoding (%s)' % bzrlib.user_encoding)
287
 
 
288
 
            self.make_fake_editor(message=char)
289
 
 
290
 
            working_tree = self.make_uncommitted_tree()
291
 
            self.assertRaises(errors.BadCommitMessageEncoding,
292
 
                              msgeditor.edit_commit_message, '')
293
 
        finally:
294
 
            osutils.set_or_unset_env('LANG', old_env)
 
330
        self.overrideEnv('LANG', 'C')
 
331
        # LANG env variable has no effect on Windows
 
332
        # but some characters anyway cannot be represented
 
333
        # in default user encoding
 
334
        char = probe_bad_non_ascii(osutils.get_user_encoding())
 
335
        if char is None:
 
336
            raise TestSkipped('Cannot find suitable non-ascii character '
 
337
                'for user_encoding (%s)' % osutils.get_user_encoding())
 
338
 
 
339
        self.make_fake_editor(message=char)
 
340
 
 
341
        working_tree = self.make_uncommitted_tree()
 
342
        self.assertRaises(errors.BadCommitMessageEncoding,
 
343
                          msgeditor.edit_commit_message, '')
 
344
 
 
345
    def test_set_commit_message_no_hooks(self):
 
346
        commit_obj = commit.Commit()
 
347
        self.assertIs(None,
 
348
            msgeditor.set_commit_message(commit_obj))
 
349
 
 
350
    def test_set_commit_message_hook(self):
 
351
        msgeditor.hooks.install_named_hook("set_commit_message",
 
352
                lambda commit_obj, existing_message: "save me some typing\n", None)
 
353
        commit_obj = commit.Commit()
 
354
        self.assertEquals("save me some typing\n",
 
355
            msgeditor.set_commit_message(commit_obj))
 
356
 
 
357
    def test_generate_commit_message_template_no_hooks(self):
 
358
        commit_obj = commit.Commit()
 
359
        self.assertIs(None,
 
360
            msgeditor.generate_commit_message_template(commit_obj))
 
361
 
 
362
    def test_generate_commit_message_template_hook(self):
 
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))
 
368
 
 
369
 
 
370
# GZ 2009-11-17: This wants moving to osutils when the errno checking code is
 
371
class TestPlatformErrnoWorkarounds(TestCaseInTempDir):
 
372
    """Ensuring workarounds enshrined in code actually serve a purpose"""
 
373
 
 
374
    def test_subprocess_call_bad_file(self):
 
375
        if sys.platform != "win32":
 
376
            raise TestNotApplicable("Workarounds for windows only")
 
377
        import subprocess, errno
 
378
        ERROR_BAD_EXE_FORMAT = 193
 
379
        file("textfile.txt", "w").close()
 
380
        e = self.assertRaises(WindowsError, subprocess.call, "textfile.txt")
 
381
        self.assertEqual(e.errno, errno.ENOEXEC)
 
382
        self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)