/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_msgeditor.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_msgeditor.py
1
 
# Copyright (C) 2005-2012, 2016 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
20
20
import os
21
21
import sys
22
22
 
23
 
from .. import (
 
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 ..msgeditor import (
 
31
from bzrlib.branch import Branch
 
32
from bzrlib.config import ensure_config_dir_exists, config_filename
 
33
from bzrlib.msgeditor import (
32
34
    make_commit_message_template_encoded,
33
35
    edit_commit_message_encoded
34
36
)
35
 
from . import (
36
 
    features,
 
37
from bzrlib.tests import (
37
38
    TestCaseInTempDir,
38
39
    TestCaseWithTransport,
39
40
    TestNotApplicable,
 
41
    TestSkipped,
40
42
    multiply_tests,
41
43
    probe_bad_non_ascii,
42
 
    probe_unicode_in_user_encoding,
43
44
    split_suite_by_re,
44
45
    )
45
 
from .EncodingAdapter import encoding_scenarios
46
 
from ..trace import mutter
47
 
 
48
 
 
49
 
def load_tests(loader, standard_tests, pattern):
 
46
from bzrlib.tests.EncodingAdapter import encoding_scenarios
 
47
from bzrlib.trace import mutter
 
48
 
 
49
 
 
50
def load_tests(standard_tests, module, loader):
50
51
    """Parameterize the test for tempfile creation with different encodings."""
51
 
    to_adapt, result = split_suite_by_re(
52
 
        standard_tests,
 
52
    to_adapt, result = split_suite_by_re(standard_tests,
53
53
        "test__create_temp_file_with_commit_template_in_unicode_dir")
54
54
    return multiply_tests(to_adapt, encoding_scenarios, result)
55
55
 
59
59
    def make_uncommitted_tree(self):
60
60
        """Build a branch with uncommitted unicode named changes in the cwd."""
61
61
        working_tree = self.make_branch_and_tree('.')
 
62
        b = working_tree.branch
62
63
        filename = u'hell\u00d8'
63
64
        try:
64
 
            self.build_tree_contents([(filename, b'contents of hello')])
 
65
            self.build_tree_contents([(filename, 'contents of hello')])
65
66
        except UnicodeEncodeError:
66
 
            self.skipTest("can't build unicode working tree in "
67
 
                          "filesystem encoding %s" % sys.getfilesystemencoding())
 
67
            raise TestSkipped("can't build unicode working tree in "
 
68
                "filesystem encoding %s" % sys.getfilesystemencoding())
68
69
        working_tree.add(filename)
69
70
        return working_tree
70
71
 
72
73
        """Test building a commit message template"""
73
74
        working_tree = self.make_uncommitted_tree()
74
75
        template = msgeditor.make_commit_message_template(working_tree,
75
 
                                                          None)
 
76
                                                                 None)
76
77
        self.assertEqualDiff(template,
77
 
                             u"""\
 
78
u"""\
78
79
added:
79
80
  hell\u00d8
80
81
""")
81
82
 
82
83
    def make_multiple_pending_tree(self):
83
 
        config.GlobalStack().set('email', 'Bilbo Baggins <bb@hobbit.net>')
 
84
        from bzrlib import config
 
85
        config.GlobalConfig().set_user_option('email',
 
86
                                              'Bilbo Baggins <bb@hobbit.net>')
84
87
        tree = self.make_branch_and_tree('a')
85
88
        tree.commit('Initial checkin.', timestamp=1230912900, timezone=0)
86
 
        tree2 = tree.controldir.clone('b').open_workingtree()
 
89
        tree2 = tree.bzrdir.clone('b').open_workingtree()
87
90
        tree.commit('Minor tweak.', timestamp=1231977840, timezone=0)
88
91
        tree2.commit('Feature X work.', timestamp=1233186240, timezone=0)
89
 
        tree3 = tree2.controldir.clone('c').open_workingtree()
 
92
        tree3 = tree2.bzrdir.clone('c').open_workingtree()
90
93
        tree2.commit('Feature X finished.', timestamp=1233187680, timezone=0)
91
94
        tree3.commit('Feature Y, based on initial X work.',
92
95
                     timestamp=1233285960, timezone=0)
102
105
        working_tree = self.make_multiple_pending_tree()
103
106
        template = msgeditor.make_commit_message_template(working_tree, None)
104
107
        self.assertEqualDiff(template,
105
 
                             u"""\
 
108
u"""\
106
109
pending merges:
107
110
  Bilbo Baggins 2009-01-29 Feature X finished.
108
111
    Bilbo Baggins 2009-01-28 Feature X work.
116
119
                                                        None,
117
120
                                                        output_encoding='utf8')
118
121
        self.assertEqualDiff(template,
119
 
                             u"""\
 
122
u"""\
120
123
added:
121
124
  hell\u00d8
122
125
""".encode("utf8"))
123
126
 
 
127
 
124
128
    def test_commit_template_and_diff(self):
125
129
        """Test building a commit message template"""
126
130
        working_tree = self.make_uncommitted_tree()
129
133
                                                        diff=True,
130
134
                                                        output_encoding='utf8')
131
135
 
132
 
        self.assertTrue(b"""\
 
136
        self.assertTrue("""\
133
137
@@ -0,0 +1,1 @@
134
138
+contents of hello
135
139
""" in template)
138
142
  hell\u00d8
139
143
""".encode('utf8') in template)
140
144
 
141
 
    def make_do_nothing_editor(self, basename='fed'):
 
145
    def make_do_nothing_editor(self):
142
146
        if sys.platform == "win32":
143
 
            name = basename + '.bat'
144
 
            with open(name, 'w') as f:
145
 
                f.write('@rem dummy fed')
146
 
            return name
 
147
            f = file('fed.bat', 'w')
 
148
            f.write('@rem dummy fed')
 
149
            f.close()
 
150
            return 'fed.bat'
147
151
        else:
148
 
            name = basename + '.sh'
149
 
            with open(name, 'wb') as f:
150
 
                f.write(b'#!/bin/sh\n')
151
 
            os.chmod(name, 0o755)
152
 
            return './' + name
 
152
            f = file('fed.sh', 'wb')
 
153
            f.write('#!/bin/sh\n')
 
154
            f.close()
 
155
            os.chmod('fed.sh', 0755)
 
156
            return './fed.sh'
153
157
 
154
158
    def test_run_editor(self):
155
 
        self.overrideEnv('BRZ_EDITOR', self.make_do_nothing_editor())
 
159
        os.environ['BZR_EDITOR'] = self.make_do_nothing_editor()
156
160
        self.assertEqual(True, msgeditor._run_editor(''),
157
161
                         'Unable to run dummy fake editor')
158
162
 
159
 
    def test_parse_editor_name(self):
160
 
        """Correctly interpret names with spaces.
161
 
 
162
 
        See <https://bugs.launchpad.net/bzr/+bug/220331>
163
 
        """
164
 
        self.overrideEnv('BRZ_EDITOR',
165
 
                         '"%s"' % self.make_do_nothing_editor('name with spaces'))
166
 
        self.assertEqual(True, msgeditor._run_editor('a_filename'))
167
 
 
168
 
    def make_fake_editor(self, message='test message from fed\n'):
 
163
    def make_fake_editor(self, message='test message from fed\\n'):
169
164
        """Set up environment so that an editor will be a known script.
170
165
 
171
 
        Sets up BRZ_EDITOR so that if an editor is spawned it will run a
 
166
        Sets up BZR_EDITOR so that if an editor is spawned it will run a
172
167
        script that just adds a known message to the start of the file.
173
168
        """
174
 
        if not isinstance(message, bytes):
175
 
            message = message.encode('utf-8')
176
 
        with open('fed.py', 'w') as f:
177
 
            f.write('#!%s\n' % sys.executable)
178
 
            f.write("""\
 
169
        f = file('fed.py', 'wb')
 
170
        f.write('#!%s\n' % sys.executable)
 
171
        f.write("""\
179
172
# coding=utf-8
180
173
import sys
181
174
if len(sys.argv) == 2:
182
175
    fn = sys.argv[1]
183
 
    with open(fn, 'rb') as f:
184
 
        s = f.read()
185
 
    with open(fn, 'wb') as f:
186
 
        f.write(%r)
187
 
        f.write(s)
 
176
    f = file(fn, 'rb')
 
177
    s = f.read()
 
178
    f.close()
 
179
    f = file(fn, 'wb')
 
180
    f.write('%s')
 
181
    f.write(s)
 
182
    f.close()
188
183
""" % (message, ))
 
184
        f.close()
189
185
        if sys.platform == "win32":
190
 
            # [win32] make batch file and set BRZ_EDITOR
191
 
            with open('fed.bat', 'w') as f:
192
 
                f.write("""\
 
186
            # [win32] make batch file and set BZR_EDITOR
 
187
            f = file('fed.bat', 'w')
 
188
            f.write("""\
193
189
@echo off
194
190
"%s" fed.py %%1
195
191
""" % sys.executable)
196
 
            self.overrideEnv('BRZ_EDITOR', 'fed.bat')
 
192
            f.close()
 
193
            os.environ['BZR_EDITOR'] = 'fed.bat'
197
194
        else:
198
 
            # [non-win32] make python script executable and set BRZ_EDITOR
199
 
            os.chmod('fed.py', 0o755)
200
 
            self.overrideEnv('BRZ_EDITOR', './fed.py')
 
195
            # [non-win32] make python script executable and set BZR_EDITOR
 
196
            os.chmod('fed.py', 0755)
 
197
            os.environ['BZR_EDITOR'] = './fed.py'
201
198
 
202
 
    def test_edit_commit_message_without_infotext(self):
203
 
        self.make_uncommitted_tree()
 
199
    def test_edit_commit_message(self):
 
200
        working_tree = self.make_uncommitted_tree()
204
201
        self.make_fake_editor()
205
202
 
206
203
        mutter('edit_commit_message without infotext')
207
204
        self.assertEqual('test message from fed\n',
208
205
                         msgeditor.edit_commit_message(''))
209
206
 
210
 
    def test_edit_commit_message_with_ascii_infotext(self):
211
 
        self.make_uncommitted_tree()
212
 
        self.make_fake_editor()
213
 
 
214
207
        mutter('edit_commit_message with ascii string infotext')
215
208
        self.assertEqual('test message from fed\n',
216
209
                         msgeditor.edit_commit_message('spam'))
217
210
 
218
 
    def test_edit_commit_message_with_unicode_infotext(self):
219
 
        self.make_uncommitted_tree()
220
 
        self.make_fake_editor()
221
 
 
222
211
        mutter('edit_commit_message with unicode infotext')
223
 
        uni_val, ue_val = probe_unicode_in_user_encoding()
224
 
        if ue_val is None:
225
 
            self.skipTest(
226
 
                'Cannot find a unicode character that works in encoding %s'
227
 
                % (osutils.get_user_encoding(),))
228
 
 
229
212
        self.assertEqual('test message from fed\n',
230
 
                         msgeditor.edit_commit_message(uni_val))
 
213
                         msgeditor.edit_commit_message(u'\u1234'))
231
214
 
232
215
        tmpl = edit_commit_message_encoded(u'\u1234'.encode("utf8"))
233
216
        self.assertEqual('test message from fed\n', tmpl)
236
219
        self.make_uncommitted_tree()
237
220
        self.make_fake_editor()
238
221
        self.assertEqual('test message from fed\nstart message\n',
239
 
                         msgeditor.edit_commit_message(
240
 
                             '', start_message='start message\n'))
 
222
                         msgeditor.edit_commit_message('',
 
223
                                              start_message='start message\n'))
241
224
        self.assertEqual('test message from fed\n',
242
 
                         msgeditor.edit_commit_message(
243
 
                             '', start_message=''))
 
225
                         msgeditor.edit_commit_message('',
 
226
                                              start_message=''))
244
227
 
245
228
    def test_deleted_commit_message(self):
246
 
        self.make_uncommitted_tree()
 
229
        working_tree = self.make_uncommitted_tree()
247
230
 
248
231
        if sys.platform == 'win32':
249
 
            editor = 'cmd.exe /c del'
 
232
            os.environ['BZR_EDITOR'] = 'cmd.exe /c del'
250
233
        else:
251
 
            editor = 'rm'
252
 
        self.overrideEnv('BRZ_EDITOR', editor)
 
234
            os.environ['BZR_EDITOR'] = 'rm'
253
235
 
254
 
        self.assertRaises((EnvironmentError, errors.NoSuchFile),
255
 
                          msgeditor.edit_commit_message, '')
 
236
        self.assertRaises((IOError, OSError), msgeditor.edit_commit_message, '')
256
237
 
257
238
    def test__get_editor(self):
258
 
        self.overrideEnv('BRZ_EDITOR', 'bzr_editor')
259
 
        self.overrideEnv('VISUAL', 'visual')
260
 
        self.overrideEnv('EDITOR', 'editor')
261
 
 
262
 
        conf = config.GlobalStack()
263
 
        conf.store._load_from_string(b'[DEFAULT]\neditor = config_editor\n')
264
 
        conf.store.save()
265
 
        editors = list(msgeditor._get_editor())
266
 
        editors = [editor for (editor, cfg_src) in editors]
267
 
 
268
 
        self.assertEqual(['bzr_editor', 'config_editor', 'visual', 'editor'],
269
 
                         editors[:4])
270
 
 
271
 
        if sys.platform == 'win32':
272
 
            self.assertEqual(['wordpad.exe', 'notepad.exe'], editors[4:])
273
 
        else:
274
 
            self.assertEqual(['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe'],
275
 
                             editors[4:])
 
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
276
279
 
277
280
    def test__run_editor_EACCES(self):
278
281
        """If running a configured editor raises EACESS, the user is warned."""
279
 
        self.overrideEnv('BRZ_EDITOR', 'eacces.py')
280
 
        with open('eacces.py', 'wb') as f:
281
 
            f.write(b'# Not a real editor')
 
282
        os.environ['BZR_EDITOR'] = 'eacces.py'
 
283
        f = file('eacces.py', 'wb')
 
284
        f.write('# Not a real editor')
 
285
        f.close()
282
286
        # Make the fake editor unreadable (and unexecutable)
283
287
        os.chmod('eacces.py', 0)
284
288
        # Set $EDITOR so that _run_editor will terminate before trying real
285
289
        # editors.
286
 
        self.overrideEnv('EDITOR', self.make_do_nothing_editor())
 
290
        os.environ['EDITOR'] = self.make_do_nothing_editor()
287
291
        # Call _run_editor, capturing mutter.warning calls.
288
292
        warnings = []
289
 
 
290
293
        def warning(*args):
291
294
            if len(args) > 1:
292
295
                warnings.append(args[0] % args[1:])
298
301
            msgeditor._run_editor('')
299
302
        finally:
300
303
            trace.warning = _warning
301
 
        self.assertStartsWith(
302
 
            warnings[0], 'Could not start editor "eacces.py"')
 
304
        self.assertStartsWith(warnings[0], 'Could not start editor "eacces.py"')
303
305
 
304
306
    def test__create_temp_file_with_commit_template(self):
305
307
        # check that commit template written properly
306
308
        # and has platform native line-endings (CRLF on win32)
307
309
        create_file = msgeditor._create_temp_file_with_commit_template
308
 
        msgfilename, hasinfo = create_file(
309
 
            b'infotext', '----', b'start message')
 
310
        msgfilename, hasinfo = create_file('infotext','----','start message')
310
311
        self.assertNotEqual(None, msgfilename)
311
312
        self.assertTrue(hasinfo)
312
313
        expected = os.linesep.join(['start message',
318
319
        self.assertFileEqual(expected, msgfilename)
319
320
 
320
321
    def test__create_temp_file_with_commit_template_in_unicode_dir(self):
321
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
322
        self.requireFeature(tests.UnicodeFilenameFeature)
322
323
        if hasattr(self, 'info'):
323
 
            tmpdir = self.info['directory']
324
 
            os.mkdir(tmpdir)
325
 
            # Force the creation of temp file in a directory whose name
326
 
            # requires some encoding support
327
 
            msgeditor._create_temp_file_with_commit_template(b'infotext',
328
 
                                                             tmpdir=tmpdir)
 
324
            os.mkdir(self.info['directory'])
 
325
            os.chdir(self.info['directory'])
 
326
            msgeditor._create_temp_file_with_commit_template('infotext')
329
327
        else:
330
328
            raise TestNotApplicable('Test run elsewhere with non-ascii data.')
331
329
 
338
336
        self.assertFileEqual('', msgfilename)
339
337
 
340
338
    def test_unsupported_encoding_commit_message(self):
341
 
        self.overrideEnv('LANG', 'C')
342
 
        # LANG env variable has no effect on Windows
343
 
        # but some characters anyway cannot be represented
344
 
        # in default user encoding
345
 
        char = probe_bad_non_ascii(osutils.get_user_encoding())
346
 
        if char is None:
347
 
            self.skipTest(
348
 
                'Cannot find suitable non-ascii character '
349
 
                'for user_encoding (%s)' % osutils.get_user_encoding())
350
 
 
351
 
        self.make_fake_editor(message=char)
352
 
 
353
 
        self.make_uncommitted_tree()
354
 
        self.assertRaises(msgeditor.BadCommitMessageEncoding,
355
 
                          msgeditor.edit_commit_message, '')
356
 
 
357
 
    def test_set_commit_message_no_hooks(self):
358
 
        commit_obj = commit.Commit()
359
 
        self.assertIs(None,
360
 
                      msgeditor.set_commit_message(commit_obj))
361
 
 
362
 
    def test_set_commit_message_hook(self):
363
 
        msgeditor.hooks.install_named_hook("set_commit_message",
364
 
                                           lambda commit_obj, existing_message: "save me some typing\n", None)
365
 
        commit_obj = commit.Commit()
366
 
        self.assertEqual("save me some typing\n",
367
 
                         msgeditor.set_commit_message(commit_obj))
 
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)
368
356
 
369
357
    def test_generate_commit_message_template_no_hooks(self):
370
358
        commit_obj = commit.Commit()
371
359
        self.assertIs(None,
372
 
                      msgeditor.generate_commit_message_template(commit_obj))
 
360
            msgeditor.generate_commit_message_template(commit_obj))
373
361
 
374
362
    def test_generate_commit_message_template_hook(self):
375
363
        msgeditor.hooks.install_named_hook("commit_message_template",
376
 
                                           lambda commit_obj, msg: "save me some typing\n", None)
 
364
                lambda commit_obj, msg: "save me some typing\n", None)
377
365
        commit_obj = commit.Commit()
378
 
        self.assertEqual("save me some typing\n",
379
 
                         msgeditor.generate_commit_message_template(commit_obj))
 
366
        self.assertEquals("save me some typing\n",
 
367
            msgeditor.generate_commit_message_template(commit_obj))
380
368
 
381
369
 
382
370
# GZ 2009-11-17: This wants moving to osutils when the errno checking code is
386
374
    def test_subprocess_call_bad_file(self):
387
375
        if sys.platform != "win32":
388
376
            raise TestNotApplicable("Workarounds for windows only")
389
 
        import subprocess
390
 
        import errno
 
377
        import subprocess, errno
391
378
        ERROR_BAD_EXE_FORMAT = 193
392
 
        open("textfile.txt", "w").close()
 
379
        file("textfile.txt", "w").close()
393
380
        e = self.assertRaises(WindowsError, subprocess.call, "textfile.txt")
394
 
        self.assertEqual(e.errno, errno.ENOEXEC)
395
 
        self.assertEqual(e.winerror, ERROR_BAD_EXE_FORMAT)
 
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)