/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 breezy/tests/test_msgeditor.py

  • Committer: Jelmer Vernooij
  • Date: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

Show diffs side-by-side

added added

removed removed

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