← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_msgeditor.py

Merge bzr.dev and tree-file-ids-as-tuples.

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