← 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: 2009-10-13 06:08:53 UTC
  • mfrom: (4737.1.1 merge-2.0-into-devel)
  • Revision ID: pqm@pqm.ubuntu.com-20091013060853-erk2aaj80fnkrv25
(andrew) Merge lp:bzr/2.0 into lp:bzr, including fixes for #322807,
        #389413, #402623 and documentation improvements.

Show diffs side-by-side

added added

removed removed

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