← 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) Revise legal option names to be less drastic. (Vincent Ladeuil)

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-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
22
22
 
23
23
from bzrlib import (
24
24
    commit,
 
25
    config,
25
26
    errors,
26
27
    msgeditor,
27
28
    osutils,
28
 
    tests,
29
29
    trace,
30
30
    )
31
 
from bzrlib.branch import Branch
32
 
from bzrlib.config import ensure_config_dir_exists, config_filename
33
31
from bzrlib.msgeditor import (
34
32
    make_commit_message_template_encoded,
35
33
    edit_commit_message_encoded
36
34
)
37
35
from bzrlib.tests import (
 
36
    features,
38
37
    TestCaseInTempDir,
39
38
    TestCaseWithTransport,
40
39
    TestNotApplicable,
81
80
""")
82
81
 
83
82
    def make_multiple_pending_tree(self):
84
 
        from bzrlib import config
85
 
        config.GlobalConfig().set_user_option('email',
86
 
                                              'Bilbo Baggins <bb@hobbit.net>')
 
83
        config.GlobalStack().set('email', 'Bilbo Baggins <bb@hobbit.net>')
87
84
        tree = self.make_branch_and_tree('a')
88
85
        tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
89
86
        tree2 = tree.bzrdir.clone('b').open_workingtree()
142
139
  hell\u00d8
143
140
""".encode('utf8') in template)
144
141
 
145
 
    def make_do_nothing_editor(self):
 
142
    def make_do_nothing_editor(self, basename='fed'):
146
143
        if sys.platform == "win32":
147
 
            f = file('fed.bat', 'w')
 
144
            name = basename + '.bat'
 
145
            f = file(name, 'w')
148
146
            f.write('@rem dummy fed')
149
147
            f.close()
150
 
            return 'fed.bat'
 
148
            return name
151
149
        else:
152
 
            f = file('fed.sh', 'wb')
 
150
            name = basename + '.sh'
 
151
            f = file(name, 'wb')
153
152
            f.write('#!/bin/sh\n')
154
153
            f.close()
155
 
            os.chmod('fed.sh', 0755)
156
 
            return './fed.sh'
 
154
            os.chmod(name, 0755)
 
155
            return './' + name
157
156
 
158
157
    def test_run_editor(self):
159
 
        os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
 
158
        self.overrideEnv('BZR_EDITOR', self.make_do_nothing_editor())
160
159
        self.assertEqual(True, msgeditor._run_editor(''),
161
160
                         'Unable to run dummy fake editor')
162
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
 
163
171
    def make_fake_editor(self, message='test message from fed\\n'):
164
172
        """Set up environment so that an editor will be a known script.
165
173
 
190
198
"%s" fed.py %%1
191
199
""" % sys.executable)
192
200
            f.close()
193
 
            os.environ['BZR_EDITOR'] = 'fed.bat'
 
201
            self.overrideEnv('BZR_EDITOR', 'fed.bat')
194
202
        else:
195
203
            # [non-win32] make python script executable and set BZR_EDITOR
196
204
            os.chmod('fed.py', 0755)
197
 
            os.environ['BZR_EDITOR'] = './fed.py'
 
205
            self.overrideEnv('BZR_EDITOR', './fed.py')
198
206
 
199
207
    def test_edit_commit_message(self):
200
208
        working_tree = self.make_uncommitted_tree()
229
237
        working_tree = self.make_uncommitted_tree()
230
238
 
231
239
        if sys.platform == 'win32':
232
 
            os.environ['BZR_EDITOR'] = 'cmd.exe /c del'
 
240
            editor = 'cmd.exe /c del'
233
241
        else:
234
 
            os.environ['BZR_EDITOR'] = 'rm'
 
242
            editor = 'rm'
 
243
        self.overrideEnv('BZR_EDITOR', editor)
235
244
 
236
245
        self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
237
246
 
238
247
    def test__get_editor(self):
239
 
        # Test that _get_editor can return a decent list of items
240
 
        bzr_editor = os.environ.get('BZR_EDITOR')
241
 
        visual = os.environ.get('VISUAL')
242
 
        editor = os.environ.get('EDITOR')
243
 
        try:
244
 
            os.environ['BZR_EDITOR'] = 'bzr_editor'
245
 
            os.environ['VISUAL'] = 'visual'
246
 
            os.environ['EDITOR'] = 'editor'
247
 
 
248
 
            ensure_config_dir_exists()
249
 
            f = open(config_filename(), 'wb')
250
 
            f.write('editor = config_editor\n')
251
 
            f.close()
252
 
 
253
 
            editors = list(msgeditor._get_editor())
254
 
            editors = [editor for (editor, cfg_src) in editors]
255
 
 
256
 
            self.assertEqual(['bzr_editor', 'config_editor', 'visual',
257
 
                              'editor'], editors[:4])
258
 
 
259
 
            if sys.platform == 'win32':
260
 
                self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
261
 
            else:
262
 
                self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano',
263
 
                                  'joe'], editors[4:])
264
 
 
265
 
        finally:
266
 
            # Restore the environment
267
 
            if bzr_editor is None:
268
 
                del os.environ['BZR_EDITOR']
269
 
            else:
270
 
                os.environ['BZR_EDITOR'] = bzr_editor
271
 
            if visual is None:
272
 
                del os.environ['VISUAL']
273
 
            else:
274
 
                os.environ['VISUAL'] = visual
275
 
            if editor is None:
276
 
                del os.environ['EDITOR']
277
 
            else:
278
 
                os.environ['EDITOR'] = 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
 
279
267
 
280
268
    def test__run_editor_EACCES(self):
281
269
        """If running a configured editor raises EACESS, the user is warned."""
282
 
        os.environ['BZR_EDITOR'] = 'eacces.py'
 
270
        self.overrideEnv('BZR_EDITOR', 'eacces.py')
283
271
        f = file('eacces.py', 'wb')
284
272
        f.write('# Not a real editor')
285
273
        f.close()
287
275
        os.chmod('eacces.py', 0)
288
276
        # Set $EDITOR so that _run_editor will terminate before trying real
289
277
        # editors.
290
 
        os.environ['EDITOR'] = self.make_do_nothing_editor()
 
278
        self.overrideEnv('EDITOR', self.make_do_nothing_editor())
291
279
        # Call _run_editor, capturing mutter.warning calls.
292
280
        warnings = []
293
281
        def warning(*args):
319
307
        self.assertFileEqual(expected, msgfilename)
320
308
 
321
309
    def test__create_temp_file_with_commit_template_in_unicode_dir(self):
322
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
310
        self.requireFeature(features.UnicodeFilenameFeature)
323
311
        if hasattr(self, 'info'):
324
 
            os.mkdir(self.info['directory'])
325
 
            os.chdir(self.info['directory'])
326
 
            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)
327
318
        else:
328
319
            raise TestNotApplicable('Test run elsewhere with non-ascii data.')
329
320
 
336
327
        self.assertFileEqual('', msgfilename)
337
328
 
338
329
    def test_unsupported_encoding_commit_message(self):
339
 
        old_env = osutils.set_or_unset_env('LANG', 'C')
340
 
        try:
341
 
            # LANG env variable has no effect on Windows
342
 
            # but some characters anyway cannot be represented
343
 
            # in default user encoding
344
 
            char = probe_bad_non_ascii(osutils.get_user_encoding())
345
 
            if char is None:
346
 
                raise TestSkipped('Cannot find suitable non-ascii character '
347
 
                    'for user_encoding (%s)' % osutils.get_user_encoding())
348
 
 
349
 
            self.make_fake_editor(message=char)
350
 
 
351
 
            working_tree = self.make_uncommitted_tree()
352
 
            self.assertRaises(errors.BadCommitMessageEncoding,
353
 
                              msgeditor.edit_commit_message, '')
354
 
        finally:
355
 
            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
356
 
357
357
    def test_generate_commit_message_template_no_hooks(self):
358
358
        commit_obj = commit.Commit()
378
378
        ERROR_BAD_EXE_FORMAT = 193
379
379
        file("textfile.txt", "w").close()
380
380
        e = self.assertRaises(WindowsError, subprocess.call, "textfile.txt")
381
 
        # Python2.4 used the 'winerror' as the errno, which confuses a lot of
382
 
        # our error trapping code. Make sure that we understand the mapping
383
 
        # correctly.
384
 
        if sys.version_info >= (2, 5):
385
 
            self.assertEqual(e.errno, errno.ENOEXEC)
386
 
            self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)
387
 
        else:
388
 
            self.assertEqual(e.errno, ERROR_BAD_EXE_FORMAT)
 
381
        self.assertEqual(e.errno, errno.ENOEXEC)
 
382
        self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)