← 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: Patch Queue Manager
  • Date: 2014-02-12 18:22:22 UTC
  • mfrom: (6589.2.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20140212182222-beouo25gaf1cny76
(vila) The XDG Base Directory Specification uses the XDG_CACHE_HOME,
 not XDG_CACHE_DIR. (Andrew Starr-Bochicchio)

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
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,
 
37
    TestCaseInTempDir,
38
38
    TestCaseWithTransport,
39
39
    TestNotApplicable,
40
40
    TestSkipped,
80
80
""")
81
81
 
82
82
    def make_multiple_pending_tree(self):
83
 
        from bzrlib import config
84
 
        config.GlobalConfig().set_user_option('email',
85
 
                                              'Bilbo Baggins <bb@hobbit.net>')
 
83
        config.GlobalStack().set('email', 'Bilbo Baggins <bb@hobbit.net>')
86
84
        tree = self.make_branch_and_tree('a')
87
85
        tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
88
86
        tree2 = tree.bzrdir.clone('b').open_workingtree()
93
91
        tree3.commit('Feature Y, based on initial X work.',
94
92
                     timestamp=1233285960, timezone=0)
95
93
        tree.merge_from_branch(tree2.branch)
96
 
        tree.merge_from_branch(tree3.branch)
 
94
        tree.merge_from_branch(tree3.branch, force=True)
97
95
        return tree
98
96
 
99
97
    def test_commit_template_pending_merges(self):
141
139
  hell\u00d8
142
140
""".encode('utf8') in template)
143
141
 
144
 
    def make_do_nothing_editor(self):
 
142
    def make_do_nothing_editor(self, basename='fed'):
145
143
        if sys.platform == "win32":
146
 
            f = file('fed.bat', 'w')
 
144
            name = basename + '.bat'
 
145
            f = file(name, 'w')
147
146
            f.write('@rem dummy fed')
148
147
            f.close()
149
 
            return 'fed.bat'
 
148
            return name
150
149
        else:
151
 
            f = file('fed.sh', 'wb')
 
150
            name = basename + '.sh'
 
151
            f = file(name, 'wb')
152
152
            f.write('#!/bin/sh\n')
153
153
            f.close()
154
 
            os.chmod('fed.sh', 0755)
155
 
            return './fed.sh'
 
154
            os.chmod(name, 0755)
 
155
            return './' + name
156
156
 
157
157
    def test_run_editor(self):
158
 
        os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
 
158
        self.overrideEnv('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
 
162
171
    def make_fake_editor(self, message='test message from fed\\n'):
163
172
        """Set up environment so that an editor will be a known script.
164
173
 
189
198
"%s" fed.py %%1
190
199
""" % sys.executable)
191
200
            f.close()
192
 
            os.environ['BZR_EDITOR'] = 'fed.bat'
 
201
            self.overrideEnv('BZR_EDITOR', 'fed.bat')
193
202
        else:
194
203
            # [non-win32] make python script executable and set BZR_EDITOR
195
204
            os.chmod('fed.py', 0755)
196
 
            os.environ['BZR_EDITOR'] = './fed.py'
 
205
            self.overrideEnv('BZR_EDITOR', './fed.py')
197
206
 
198
207
    def test_edit_commit_message(self):
199
208
        working_tree = self.make_uncommitted_tree()
228
237
        working_tree = self.make_uncommitted_tree()
229
238
 
230
239
        if sys.platform == 'win32':
231
 
            os.environ['BZR_EDITOR'] = 'cmd.exe /c del'
 
240
            editor = 'cmd.exe /c del'
232
241
        else:
233
 
            os.environ['BZR_EDITOR'] = 'rm'
 
242
            editor = 'rm'
 
243
        self.overrideEnv('BZR_EDITOR', editor)
234
244
 
235
245
        self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
236
246
 
237
247
    def test__get_editor(self):
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
 
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
 
278
267
 
279
268
    def test__run_editor_EACCES(self):
280
269
        """If running a configured editor raises EACESS, the user is warned."""
281
 
        os.environ['BZR_EDITOR'] = 'eacces.py'
 
270
        self.overrideEnv('BZR_EDITOR', 'eacces.py')
282
271
        f = file('eacces.py', 'wb')
283
272
        f.write('# Not a real editor')
284
273
        f.close()
286
275
        os.chmod('eacces.py', 0)
287
276
        # Set $EDITOR so that _run_editor will terminate before trying real
288
277
        # editors.
289
 
        os.environ['EDITOR'] = self.make_do_nothing_editor()
 
278
        self.overrideEnv('EDITOR', self.make_do_nothing_editor())
290
279
        # Call _run_editor, capturing mutter.warning calls.
291
280
        warnings = []
292
281
        def warning(*args):
293
 
            warnings.append(args[0] % args[1:])
 
282
            if len(args) > 1:
 
283
                warnings.append(args[0] % args[1:])
 
284
            else:
 
285
                warnings.append(args[0])
294
286
        _warning = trace.warning
295
287
        trace.warning = warning
296
288
        try:
315
307
        self.assertFileEqual(expected, msgfilename)
316
308
 
317
309
    def test__create_temp_file_with_commit_template_in_unicode_dir(self):
318
 
        self.requireFeature(tests.UnicodeFilenameFeature)
 
310
        self.requireFeature(features.UnicodeFilenameFeature)
319
311
        if hasattr(self, 'info'):
320
 
            os.mkdir(self.info['directory'])
321
 
            os.chdir(self.info['directory'])
322
 
            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)
323
318
        else:
324
319
            raise TestNotApplicable('Test run elsewhere with non-ascii data.')
325
320
 
332
327
        self.assertFileEqual('', msgfilename)
333
328
 
334
329
    def test_unsupported_encoding_commit_message(self):
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)
 
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))
352
356
 
353
357
    def test_generate_commit_message_template_no_hooks(self):
354
358
        commit_obj = commit.Commit()
356
360
            msgeditor.generate_commit_message_template(commit_obj))
357
361
 
358
362
    def test_generate_commit_message_template_hook(self):
359
 
        def restoreDefaults():
360
 
            msgeditor.hooks['commit_message_template'] = []
361
 
        self.addCleanup(restoreDefaults)
362
363
        msgeditor.hooks.install_named_hook("commit_message_template",
363
364
                lambda commit_obj, msg: "save me some typing\n", None)
364
365
        commit_obj = commit.Commit()
365
366
        self.assertEquals("save me some typing\n",
366
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)